From aa6591afe9db002ce57c8086c6b3512271805221 Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Tue, 2 Mar 2021 13:07:19 -0700 Subject: [PATCH 01/52] Update KQL field autocompletion to suggest fields that match search (#92559) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../providers/kql_query_suggestion/field.test.ts | 11 +++++++++++ .../providers/kql_query_suggestion/field.tsx | 3 +-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.test.ts b/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.test.ts index bea695779fda6..afc55d13af9d9 100644 --- a/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.test.ts +++ b/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.test.ts @@ -78,6 +78,17 @@ describe('Kuery field suggestions', () => { expect(suggestions.find(({ text }) => text === 'machine.os ')).toBeDefined(); }); + test('should field names that match the search', async () => { + const prefix = 'machi'; + const suffix = 'ne.os'; + const suggestions = await getSuggestions( + querySuggestionsArgs, + mockKueryNode({ prefix, suffix }) + ); + + expect(suggestions.find(({ text }) => text === 'machine.os ')).toBeDefined(); + }); + test('should return field names that start with the query first', async () => { const prefix = 'e'; const suffix = ''; diff --git a/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.tsx b/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.tsx index ef0f27ee93bb7..ac6f7de888320 100644 --- a/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.tsx +++ b/x-pack/plugins/data_enhanced/public/autocomplete/providers/kql_query_suggestion/field.tsx @@ -58,8 +58,7 @@ export const setupGetFieldSuggestions: KqlQuerySuggestionProvider Date: Tue, 2 Mar 2021 14:08:03 -0600 Subject: [PATCH 02/52] [Fleet] Fix default integration name when adding 10+ names (#93278) --- .../create_package_policy_page/step_define_package_policy.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/step_define_package_policy.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/step_define_package_policy.tsx index c66a28944ea71..64837b208ae45 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/step_define_package_policy.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/step_define_package_policy.tsx @@ -47,7 +47,7 @@ export const StepDefinePackagePolicy: React.FunctionComponent<{ const pkgPoliciesWithMatchingNames = (agentPolicy.package_policies as PackagePolicy[]) .filter((ds) => Boolean(ds.name.match(pkgPoliciesNamePattern))) .map((ds) => parseInt(ds.name.match(pkgPoliciesNamePattern)![1], 10)) - .sort(); + .sort((a, b) => a - b); updatePackagePolicy({ // FIXME: Improve package policies name uniqueness - https://github.com/elastic/kibana/issues/72948 From 6be9adac0d7c17a6c97e9cc5eaf2c3ed99afa8a4 Mon Sep 17 00:00:00 2001 From: Zacqary Adam Xeper Date: Tue, 2 Mar 2021 14:08:55 -0600 Subject: [PATCH 03/52] [Alerts] Add spaces as optional dep to triggers_actions_ui (#93267) --- x-pack/plugins/triggers_actions_ui/kibana.json | 2 +- x-pack/plugins/triggers_actions_ui/public/application/app.tsx | 3 +++ x-pack/plugins/triggers_actions_ui/public/plugin.ts | 3 +++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/x-pack/plugins/triggers_actions_ui/kibana.json b/x-pack/plugins/triggers_actions_ui/kibana.json index 0487c58e66269..2938d94bf426a 100644 --- a/x-pack/plugins/triggers_actions_ui/kibana.json +++ b/x-pack/plugins/triggers_actions_ui/kibana.json @@ -3,7 +3,7 @@ "version": "kibana", "server": true, "ui": true, - "optionalPlugins": ["alerts", "features", "home"], + "optionalPlugins": ["alerts", "features", "home", "spaces"], "requiredPlugins": ["management", "charts", "data", "kibanaReact", "kibanaUtils", "savedObjects"], "configPath": ["xpack", "trigger_actions_ui"], "extraPublicDirs": ["public/common", "public/common/constants"], diff --git a/x-pack/plugins/triggers_actions_ui/public/application/app.tsx b/x-pack/plugins/triggers_actions_ui/public/application/app.tsx index 0a59cff98ce26..0afb81031e3bc 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/app.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/app.tsx @@ -17,6 +17,8 @@ import { ActionTypeRegistryContract, AlertTypeRegistryContract } from '../types' import { ChartsPluginStart } from '../../../../../src/plugins/charts/public'; import { DataPublicPluginStart } from '../../../../../src/plugins/data/public'; import { PluginStartContract as AlertingStart } from '../../../alerts/public'; +import type { SpacesPluginStart } from '../../../spaces/public'; + import { suspendedComponentWithProps } from './lib/suspended_component_with_props'; import { Storage } from '../../../../../src/plugins/kibana_utils/public'; import { EuiThemeProvider } from '../../../../../src/plugins/kibana_react/common'; @@ -33,6 +35,7 @@ export interface TriggersAndActionsUiServices extends CoreStart { data: DataPublicPluginStart; charts: ChartsPluginStart; alerts?: AlertingStart; + spaces?: SpacesPluginStart; storage?: Storage; setBreadcrumbs: (crumbs: ChromeBreadcrumb[]) => void; actionTypeRegistry: ActionTypeRegistryContract; diff --git a/x-pack/plugins/triggers_actions_ui/public/plugin.ts b/x-pack/plugins/triggers_actions_ui/public/plugin.ts index e4477c6a8e60e..7c3c273c1f384 100644 --- a/x-pack/plugins/triggers_actions_ui/public/plugin.ts +++ b/x-pack/plugins/triggers_actions_ui/public/plugin.ts @@ -25,6 +25,7 @@ import { ChartsPluginStart } from '../../../../src/plugins/charts/public'; import { PluginStartContract as AlertingStart } from '../../alerts/public'; import { DataPublicPluginStart } from '../../../../src/plugins/data/public'; import { Storage } from '../../../../src/plugins/kibana_utils/public'; +import type { SpacesPluginStart } from '../../spaces/public'; import { getAddConnectorFlyoutLazy } from './common/get_add_connector_flyout'; import { getEditConnectorFlyoutLazy } from './common/get_edit_connector_flyout'; @@ -68,6 +69,7 @@ interface PluginsStart { data: DataPublicPluginStart; charts: ChartsPluginStart; alerts?: AlertingStart; + spaces?: SpacesPluginStart; navigateToApp: CoreStart['application']['navigateToApp']; features: FeaturesPluginStart; } @@ -142,6 +144,7 @@ export class Plugin data: pluginsStart.data, charts: pluginsStart.charts, alerts: pluginsStart.alerts, + spaces: pluginsStart.spaces, element: params.element, storage: new Storage(window.localStorage), setBreadcrumbs: params.setBreadcrumbs, From 319ad55cd742858e2d6d4c14a5b6abfe8f9b855e Mon Sep 17 00:00:00 2001 From: ymao1 Date: Tue, 2 Mar 2021 15:24:06 -0500 Subject: [PATCH 04/52] Different screenshot (#92970) --- .../alert-flyout-alert-type-selection.png | Bin 255161 -> 166951 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/user/alerting/images/alert-flyout-alert-type-selection.png b/docs/user/alerting/images/alert-flyout-alert-type-selection.png index 4e5c49975160f3e810c22b0140512b04880aff18..6ebbe4213ba7d30b06bd3f36c372d88129272f6b 100644 GIT binary patch literal 166951 zcmeFZby$>L*EdW`NhlK1lF|awsYpxrP}0rN-3Tb%-CYCHIfRsShong7NDLj{cwP7N zJogQL$NSg&9?u^a$1yYKdG2%9+H0--Te119ASZ!|PJ|8z2Zt#o`A!KA4ygtX4%r*^ z5$p+2&$Js3?y;r0sHlRJs3?VkJ}A0CDDR5}dpO}8#So;D+82%Zj}qN5YCk>V2%&1W8ZOhqqub67%hj%cZ~c3Y3Y z$6gMbBgq_h^vR7bkKjPM87e8k7Kl--^ieeLK7Q#b$gh?pg+p%geVpct8OfShwYq8u z7uRtMIXZYG5_h9YM>8Ybdsn)J{?T3t?wji;4rF_8p{^mgAH?TMn(%P%@|Wx_{8T<~ zzAd8*fPbr9(Dj|6MdmYyYJ+(@ExjM&p)uUI*JSbun7$i=MW%R1)h{A9=sxLCBUB>6 zfu7)?9El0QclFOotZmAx{Y3w?p9OwqK#2XT?>dO%3V59?dM%)Piles9NwKC-sh!fB zdh3(0;UnXnVK5quY4tjqiTzEoaM=oIp>It3eL#au%yZ(xGR`irfnUi1T$V~SCA+3^ zB+>CYiH30d$62vjL;%w!s@&9{%$G5BP)+hzS{;eK|%b<@b1GYPe_ z_n#vGB+{&YnYyeN`0lHhUx5;`U{sfK7cTit_1G{)EGJLpQ!$PfUWl^6i|LQEni;8t zpt|R()IYnh=Ds~c>purk$l*v+zE!!_&`)3zcw?;>!%99#Fi-i^!Eowa#P21&k}CNg zbtX5C@E~$CQ{0zW6t|B@m23fxs2{WSOBO0O-%8o%q!g+HaALAjLY4E~4lO(u-X;-b zPil$myGSaP#{^O_0;i~4i|2eg4nyVrfD}yc`b}K>`92P1vQ z%g8>(;$Pvhzlm_+d?hUze>^NnN*LX4O8FAOM}!*bDBJA?V(wc7RA^>!O-Ui{HzGo2 zlB8&ijJIjnId90WL4-*(&yNxiGDO19$(P)|9O}2YeWCBY1A8l6sdfgX5Y~#bZAIsE znn^vT3VKTQdF7qQ0xEXb%^~6Wm#w=SIeDfz##h=+zP@@k{nC>!!pXdmVKHaTE7M>QDVSGobzrU6oJ!f}*|tBmRPUQ2R3t1pcH*;$H~26oeoB zUgDs{h!7>AmNNP8YCkIQPyRsm@=^W=WDUgWfT0h>v&g6Zh*@N>{Z@axZh&J6*!{tx zElB!pwsLN#?BYXUTh!B^fH|-U9SU|V_wgx_Jr->nr2CrJ+ltK6}pVp9C zL!DWav`-wi_ym41r<6f)qb3_nkr6{U=REESOl zr$q8uf`I}rb~^erDk8c(icb=3gjx0cdpL=l9G%R!J5p%AX_l%Eox zb5UPT&=1hh(}%~ >L3s|H)hU}n)OIusoj;Y|W|=ywEnv@kI-F);PQ*@z6n8;S6U zt~iG+1SZc#Ch~bld1?+{BU?YWrUNBAr=BLr70!lZZR|U?ISfahE zbaHfhrp3cH=?;7&PEt)=P5Mm;i-Aq^j`CYVCLbQlJPPhGW%^)cnr7g*^#p1KZE)vx z&v*BL0-#M$C#c|w@=4*g`VRRR(A3~PF>PXUulBG&drQYP&!7>ZN0RMqjDBrr`C|{@ zs|AW#5iPAvRG8yOoYr`bul+Q!`gAvK# z58KtVWddr*yVRxg3$p^_+WM_iEmJKcU#BU*8?<%{go`mx4QAJX+kdoy{@9+vC>i z06s2_R->AbC?|0I;VpLQR`7huqx0X z5x>Hco{W)5eF}@ve(n})`E}i)v~f{!NwGRdPJAK*37ibXdjIn z#=iKpG%G&0xizlh+!~EJp>AM*3jJc0*>@~n%1jF2%h7<~%TRRwZtRfYK)=BFK(MlM z0a;oBhb;U4PsiYGnF3)(bkuG@wd>i6} zi=2^stS(EyW1WqPl)D-KN#t-0S^Qz0^Yh?O#Txzxx0~g!l$eQfa#_M%ZmcMF1#2#Zna0Cg<5G-)v=P^Qi+Ok zM#K2{xSLv&@f3%3vh~y%r5T3lI`uA<*Jag!dV|G6XbyCSQIz4#`qk1Gqt2^v|8R9K zWMIjnRaK+oaWC^v=K4BuD^O`wF~hR>f?C7=_G#R{srS)Ev3u}X#5ifDi?nkcM0(b# zYOcA-z5eiEozpBlr@&$4Trlx0=)k(jsbsM!va!NZc(!8p?&oG$CXnQl(5U_B=7)XO z={75#E*=%7;7Qqv-ExAddhR^V8qx^9h4HOr*Ddu;Jr}NIZdI}|;i~JG(5j$4J>B`ed9IBuyC&kr;o${GHok9+KR_)&l9K1KNGS7JRd^&dD zE{ctW274c0?<w3nWZygxkt|rQ_ z$qP9#c}n{LZU^@?p$_$%vgs@7iF#okV~0wYRTZV@*y+MtEma=Sfy@pc-957T#Y4bp z)7{W`eGt&)cKuLYM&5HIz~usRxs-T9bb4_4<9KDTcQSJ1vcQ|ttK{73uJKUjB+=vM z;^syvBaGYjS^Edk>MA(bYFs#XBDlw{L0J*Xi^wQQii>(EIOp;jPI@FbtZ)|kg#tYe zDe$w{sYBY|Fg@0v2+-_AA0c?+|GpN7e+h^9*K-6oxL|WQq<_652mAf~7X|zL zuJiXVVoVSm3heGF?Bkk+@Lz8u)np<5*EO;?tPJjrvZ$04>{r>)-q_g2!3^kFwqf(T z9W+}>O$RtQe45`Mcqt|7U$FLP%~doUHDurO83L_Y^o@W9#w@PZw!hnf6L95&U0NGE z>QlH{TiH19xe8ML^#&j8`uAg2N{YW;akLbq)R0x65Cz&BQ*g1oVtGX=gib+0Az*K0 z!l(33{9n~!cY>5=j*hl`tgJ3BE-Wq_EI@lxRyJN|khbZtG|cw4wOjuD$`#$x)D!@^?r7{rC4cja|+ErzabSe@zQELDt_T ztZXc=SpU0iSXF`FPx%zgU5%|Y-=C#`dB>Ygng_LjSX1|Em1&h5xE3!1{ac|3-_y3H{eo7^Q{K1z7)k)r8Oy z&%I$LFC2;aJ9!n@FO1E8{~@%&zFz+Q3%iELe)DC*+!_u}1WxMR8x>dhy+xFy$#>+v zhr*~N`&(dwZ81IuE|10Ori)b}n4*4ez%kHlw$Nq#X(UM2}cAD{@xb?^TGW`f4w1(hGXVd(pbdwU>L9_{qWBo z4v)guw-5=nMqo-?1^*9C`ig{lJm?+PRl725;29Py455E$QY5Qe@DFpP_(2bkz%0*6 z5HI$JCMiaLl0BR#63(wUIKPC#l+gY^kq^hr4*QQpm-ZDIP#zL9e)5MVQEM7d{y+Z$>OpuG$@; zUoJ6FX|$S{_{>hknuSuP?ADpOts6lSxMcff>~P@nL&iMZSWQ<49u*90OLA2+Yd<^7qsm?3UsY@}8l| z_5iESj`VXO$E>bi(+B`20;tHEh#}}XRCqo1h}>TGX1D)7Bqbf1sNR z`gxEhRS?*4^0==sBl1!qRD_WMNY4=Xhep$VwUUg542tT-Jc`7!;vLT(Nr*pGT{&_T z*{=r5tZIS*NB|R=!_N;}%Cq(R@Rcc+B1IHbgk6J0F2uC#B`l>@p-ZJzZxbt<%01v0 zfI=;QAP^($BSf!OQ#4tjr*6}5%hwn6BEWo@4#67%67H#Ya$_Xd9ZC@EanL%Ty@q>F zU;8~{#*t1ke*4a{2(Q*}I;D1ZtuwOc+pOKHZ09@S`5GG<(s|)RUB>5`W}4_-8SS+* zi_}^wFD>NO`xBzgh40K*j_wa#Bm@tYZjhZVhix*XUu3r$O;55{E?u@hO2}co{{`?2 zLWfB-iDBLr2hcc^B;r3%?p>cM(p4>Q+_30v($J7Z^P3(~F6>L;+$9;BI_=|%p_L`- z<-@XH0$V?SFBTB2$M6HYWd`6FvZJhOCu7hU%= zFCB64-HNf^`L`9(Jk9EYL@$yG@(;%w%u1V&OdHNTn@#g3F!sUT<}YT1X^;RTE?d-k zo)@*Nb2Am1!>e^zPwo%E6WK876=S!N=}5j1;1zkxBS9Uw%gX$~I~+gMS35b$jh*d{CxG?R9zL zJ#S!)>^GgCKs(xG)IoAze0A|Zg^28)AL5RGIUI_BZnNiF8XXPs`N0!GM(y24jzR6TGdX?P9h&&9Sh=ulorKq3QWM(4FG$L3|E@qb^93I& zpYvYQGbRm@^5*i0IA-NJ1_*z(#gxVO7UNK>E-B?KeLWNk^C(4148P*+xir_+0jvsFK-@FQS$%dIr&0X332!EI?GyY}<0kXElM??rbB(o&U1 zX?BxAv$Ctz$nL6>5nk6Hq|&#Ke#`5diDHCDYBYqOsyxTaX| zkFTA+dPH3Rx=j-^GDaI#2oXf6-sOXf*uB>PXWVwKeex+NI$ zem{jXPc~H|-#oUbHB~#&i4fXHm)YNNm|60}B+~LZxa!@Z!T4pRn*Ao}UF={o2XFt) zuTJ?R*LhQt-KSc!RdyhERo4Wm09%HBin)CFbPqriyrV) z>C7iAfws#HV!T%wsIIrfDqFKv>jC1Zj@@_%Gb{54>nfjk_czHA$v9%HuNTj7*NaUv zT+%ErCo`!7(91H+XLRvdHFstU2u?V?_`JikeGI*%%*uF{N%d3^Z-omV-I~6=r)DYg z(WyPMYMth}8ViPHy<1BYSfiOVtIk34R$`mwi$;45hY<#Xx?Y-dHQtkeO=7Dp5g8PA z(IBvCeC3GIaGK(+cFQPH=q{w~E}>4oHa59>b2gNQ$LCDPMY3Y1DbyQRBy0OD&_^mcrFfNSRyVB; zrOp7>Vbknb#ofU)#+EvT2vfK$AN!W+Ks-GM`CJh=oXWv~o=D==Ib4f_g$sKKBJ0;Ciz<7@3uG;yg}lqk?<_0KaFe5zLthA>R|t26uEB=&n>3@$9s1vz$M_iYWDc z0)8!q3az^iw6OP9%%}Mw?uFi#PN5-_+YtWr#};s~sha3t8JP#ls6v zM+`x^OLwChrgy?Ot~Mz(=4Gl*s_kyDy+dnY@ILB{8b^Y0g8SMS7rWCOE0%h-X^5dQ z5`kv`=J6<>!q!xE^Mdm(^V2g3#k|&J*4~Eis_-?BCYjHXd36KyyF@s2s;WC6!f$gV zouBStl{;&{*hqzt7}`VCJH`UA7k;aXt&aZPY2exnqSbzhvG@p$$9G!Zx z>Ss>NIgKDpFYXVKrGXd(efus;hQhU+MU95WI2f1LZMSvpW4P8kYf?(Bp1d<)=sba? z&gx!to=5i0t8Fa_w`FG+jGCB|aF`Uy3tlv|EI?@_1aScrqtcSW*7u-lC1uo}pIY)! zJc*!($HT=hmPQCl=Tcmdxs;B*#ybj_vB{Sa+d9uCJ>~0s5 zPYrrnuu7&uT6E3MkOX%p;L*H|-r?KA;iK)3tb3)CY^FsW`=LD3jZ;@{&_^wDJF>1e zu?O&Kwc^&jhMr9>lh?c)G&)U=Hq9Elb1trmLU%`umYO3>*Vg6FUPdifvdkjiyxcfi zXQZ)is!>`m=|?+I%RQ})up6~s@7I6423&@z3NJ)v?o!FxO06u_%YH`V{ zJLR>_n#N|`XvLityX!aG-hwH{1Zhvt7DJsc7<`TvlX;D00B}#`Kn=aHWTU+?>F&bY zl#d9^f?3|xS`b^3T-jZ<@zp7HlHCP-lj3?IprsGeOfVGUZeB229-wL{OP#^;~GAS8Oq*TgM#*7$2m$K`V5#+JYb-aX_i!BX z3uK{IMy(vcJW(L;aw5(?AVE25kD+^FXb0U{G|Hg;v8e{_X~kmYAF2v=*9p_m)7B8-GI z{r9v@o}-@;cFjT4CcI$_HUCM;x(u~U0@JDLlXTeZJw0|B(#zJVBKuDCOq#6GEnyNa z8wJ>r^=+M4=?q?PhS2quX*#S`tPf}hFfMxyu1g{Ts3gJ@GQgK9!7Y0uiF{6R&Lcv2 zr*@9m)fH_QYA1v`p@}SZnB@qh0+S+)^z*aKqnBnUlIF8tyt8(i%jrh#jrD2nu}K&j zj7_Ev8nKSziEtK$WN%mai&ctqyj0(9cEZfjM;L8s(icMIMaxz*`%@X-h6;i95wL-H zU7p73Q;7%J&mj#wx@yRQyy3E%eaY(N*3G(i!kjp2{}+ka{M6nucXQpxYj1HSPelgy z!`)dOUFGJ4msx5U(Xt(1BLN_hB($=ruemI|PG;H6$ExC)t_|%J)D>Yn*!KqWYQ678 zk88-3SAkCQp4ZG*-DRqXtIJ*x#0bCb{duoVC^2T@?fM<1-x^lUp7r~z^?3`X`_2QL zR*@=l{Sb_2rAY5nuI_jY9%&MT!AZSgBYf?)^EXEx>_e>?|t7{NS9tj|Z^ z#PF$F9DjM?rB8Ku zMS8`ShCHcQ@dKZ%{NHBF$`gyM__*IwF(Z1QvKyFwbC;v9VzxbATV=G+?T5J6W(urp zp$;BagGwLiWzFWWsJ7jkl%3Y5$Z!lagn*lSG< zGp?_keG8M~l5i*FMeXOJ1GV&;4@}*h-{QMXv{RWYbZ!=wTh(a49_3bTD!nn7OtOm$ zI2RSHa+xP}xx&+Iw5nXS{5KaipcsZz4D0^| z?s=v!SQ?O4naZrjjD{!fvBL(s=~Cze&~d4X>3c?|L<$R=kd7CO;c zeZt=sF2s03@soSmK2=Y?BB&&BMxvxX(F?{X*a|#y<$lV#KI1vhO4-;uDrRj zHPq&N?WZWC)8iS@iV;*D5s{_^82@MuC_Ij^Rvr^;AbrdUb+x1I)8 zA|)=mOEGI*O0;KaUViZNANcS4ES-G@5;W=OYaLlhfxDbTZpY`6p$Zfw*Sd>5F8h zdt>{?<`Wx=yR)qv%7t=?5@a3=F12NP)!OVv-zeG!ljxbryay}6XO@fkQ&hut-Gd01 z?jEN*RKIbXwy{?eGC-@|I@WS$!6<(0FNiI4w};!ycjZ4XawAL39rL85P$lK{!AiQ2 zd}j~$6>^B4w~+2hgL;RY&1S~Y>Y0+_B8tt#Sgu6;a&9@|PB4+#_9~qi@$RZP!>D_< zvgw86SAxr^>60OK+&r}*qG@)Hd%yq{rmBn3Y8)$aX=Q=&wYxLTDcowSbc=4i`#C7j zBW1|xP_W5j!il;2dJTK}*rz%NtSu%0V10<{9rs=!vDwXQw~!j|Yx*|jMTeR6@tdjg z7-lUl%hcA4W&CRvY=M(cwZmzRdYDRg2}HQk@-Qz)tUG2(Qfk-;%wFuT*YnDDcjP6{ z<##zqYsn!SA>p@a$!%%;fp3PqGX(vKvA;g8l~Ss!?zTRAxEjN+&T{;!%KFN=@p6tB zWb9A?m|{3O)dKP$yj{$-40pFW`o78ctz^n_FsH|Kj55&pbZ{G9^p(Vl4?$0{rAM(P zcP}leh1|Jg*=nVt&X0D#fN`ZjO&cK3s}4m80&{qy!zPPc4HWlt5FT2` z?kmglFCEi7s;$PXbfbLsYo7!rj}$e_9?4^y5^=4OHttVrku*06I&ZziS$mr$vKvfJ zH?S%%l>S4J3#3Q0J)U3Pzm)|FB}x-i0KO{y;F~NlMHLG}si^#O$Rln&>)j?F4*v*$C&0nm(6+|1__q-q2`QhYOgi-T)>oYFh z8VvOXlN4-8Krc@ZXk4x#Tre+?YI|KHj1J@~!aXypfr6P{x5n)b4c3ImD_2Tw-a7TN zM^|5kCp8p62&c|f5XTwPdKnOm9lD2E=hd6B(1G~27%GF-m&d`MmnGv%8RpfWA74ff zmsdERX=RRvMC{K?1)q-4s8EktlY0rM=^ji|joCMeEH4QfZ;!XF9kaIC$6<4ij-z~b zByPS4=6KmsJ`Y1d;lAt&tRgq;fo$aA(_+c@tYI9xgi!u<(wyBu@5LHIjP|Z%(|B>Y*#3spY@&lMpEn`uJy-@W|+^b z9e~eR`eJBg{Cg*X-*KeDN-!bSEu$hnZe3-RZ zZZ5$zK1{l61Zm+UY$_>>dn5w`3-U9&6Ck86Cz7XCGN{pYzI9?N&cEo_(@nE@uywS1?)8%OjJw_9c?B z{Fz5?lC zUmR~@FmzRsGmaliM3Tnt&({%0%47(*DGlrKup(nTi$g#@DrL(&`uO@~Q+cX)nbm56 zY?VPb1FyqIjZuG6ACFqTbo^VPg!$SXzlD06MOu%ueU3)})~v^?tE-D4eADSLW2vrq zccIp@o`lD>eYOB4mQ^9kcMQwU&Mx988o=YU6IZ5&I0BsgGPcE=KM(#wWUCvgeyS%M zZL=yleKlLTT4l4yw;I)Gzo~Sl>-U8W8fKLKF!~}z|05X&Y@hIO-QTid^6BdW3%RyT zs7*fmPv_5HPA?Hy4A+kM9zOr;*7cvL=3f;0C;0rY2-82o=fBnL|LWlLKdBu5rR4ru zroTgO|LZeuL`v2zU9?YB!i)cuNF?$e1IMh}@z~+;KGcNmY-dQWYoi|4;^7Z7Z~T(* zDMmxKH#UDhEQ5#q&RnV(Dq?%MUE)l@a*fy)ueI;_4Sy@aAA+!yB1r9X&OgNE4FJ9( zj0LHgp%V9kNwC`%I#{j`m@BvE;S~N4(}Qi?GbWRS|Hae)lV9}793BCbWaG_3_OR?% z1}ur`Y%YxGzLN*W5NymMS$GpeBi(-}Tf&7Uf$63y8r}y{ump($WYijiri(_`hh^;^ zFp4c%a#(~tOhxFbf%8*)&n-+4`LN7Y9+o!s&*J^hn*Me5&*J^RkvtrIzX{XfzC+wX zF`o=U7a>Xs`P2>c&oYVP?8adnLR9t&SO%ytY)th48^c7FM8H!!qWBdfec>R(WPdcX zvQh?RL4<4;p7PL8_k9b~*H`BQ#4p!==S1_WggRB8JW=gvElj>@wRhYPt;V3Zwo&bY zP<=tV4b9M;?z>ITE=;J9bR9qftTa{!4I_U`$4ZGv}~U#T!xcv7<4HVb|hM-dFm!0-CI# z4=hIT@+bg^&q*?qPTkk0E&Q`(`dUks$^_gLUZ=~NFtw`+K(kP`K@77czT0V^1T`>Y z0e)crd$ZmW>0$PhPsmJpT(8Y-V_#b;jc`)Tw;Cq$^+@dCWz!*$QHpB2yWJ-D=6&$< zgdg|<|3KM3C75kG{_rzUTbe}J`TarLne&Ci_EW>%P7q+g5`5Jd_uf@C8iDsIOZzku zvH|-jpVLmwiMwGG39tL>HzW>*JCnuvtJT(dX3=jq76;et1U_1z@ABoJY7ppWASag_xPza-z z3O2I??6v~~HcC9^qzUK`BtSWnR4e-i0?3J& zYamNMm-LHqInxVkfFQ;8#NC9YbntuO_qSrS@~PV|XR;2U_RU0v18KB3uNP|vt%ryJ zk$7YmS4EG>Io0YQ3&sZ~o~PTlIc!1+Sl}k8`#>egdKX_QTie`nu?d=LH2Mp>Y`w;O z{F^VgZtbwX^@m3f25obKG^>Tp++fPkl;R)+A2ft~F)z&ECglpqB zCL;+`TW;%IzphO6yjdN5bj;$Xz%`f99Rp?;Hz=mWNQtF|YAg!mCbM=ijn{GOlOu$` z{ZQj)z}W)J%w)OEP~mN|uuxvgSys z$bb;|`_(#<2Oo5gf0PYtdUa>4s~>NmFGSVS`25NcB)XlU3vL2`U=C)VI2(FV<#0yU zrgK7!56ul$FFuZE)C!S!eDhJm@4jAeh2f2rMzH~1HaxR^b;O!81^9U0?cU3iRWCGI z(d8=*HINPvukp%fXuW6GVxUFuE=s=bdKjSBWMpT4HkmtJmGPYamXX)tw9GKQ(Ker< zA~Kgwr$Xpv+3AFYV<0)xJ?o;>QY~I9mDB$5d!Wtc{oF@*B!2>mQS>DSBAFhQtXflu z(DoE$+|b|M7V3A?L^sRQDIO6WZ#k`Le9#I`UU0pcVz(Ry9(C6XYwQjr($mNbE{y}G zIrjOST*6X~mo+M3C*!K1qSGb6y|e_&*A$@%EEo-uENT3vSlgoqcArPm`sNZJq<7(< z%EB<`>k2bQQf0sC;)%lbz;ZCDbrvEssTFdHCpn5|O}C&DNSa3Taz@(iZdD$%c(m3} zQ{n734C_4`39u1iI-C}7%&0bS6mMy?zT;$n-IZ@wKgf=Jv>socp20?N@$NpF^}~T7 z!M8}ERX<_WH}_bMDqgLQlsPmA)Ja{xzBm?#Ga-N1+6mKW?B%~3UDtd7 zv;DeYoj>Ic*?7uEV1`M=2bi{Au&Vv+o%^HOT1#`_G+EDND6yjLt`CqeS_)s`68pMD zA`z>3&c%D^(DetiEV1P3BW}R@J_mVNGDYZ}whhQ)DX;alxohnE3_fLiR&dR2hX*h* zM+{wa{Ul6CebWZ`t#6{R3<@G^k|D^(Iqyvs8UTK=LL6mdPvrr;4?62BfDd{Ec#b={X(WqX)8U4_*$S7-BLyNjvMSj8Lq(e*0ud9#7S>u$as9?zH%8`B*s zU7}KK6iucD?21n1z@n~4Ot7IE|r*UujqMtJ?rLM(Hf4gYO z@!P|!@D-Q=7`Tbg?9pwMm48@oy-Y8+{-X6YYh!!tgjf zh&AWf==T>+xD@nHdcgwL)+tSaVHElC!pQ1_Y0DC@O`Sr zPN%WX*=fwl@P0TG&hHm83*9IH?4JL++y`uTG;KX6T~7uUEr&%5c;7Asld_<>@{Kk* zK2H=b>;we_V+|x%n}$~w|Ku=b?`cQh{02M2z!8xjP-w*74DoO38*M0T}arR0Gpt$iEZIlN%`y+J} z3Akn}9Zv}tndyBNUR2P7$QMP_IPxhO4@03`=8ZfHhnF^>FP7t0m{(m|7|l;j8mM26 z{g5Wl&RN|p#yA)|Xi?p${M5b~?L7ob^s*w6#ZKCoPb-9}pr@j+jCDaZHCj$o0Yek9 z(})+NA!T$DqW9G_tSdhds^+_a93E5yxdXY6&WMDC{_95SjOrpb%6tuXqS!e}^+&@zAm*o7Qin0={@!aX4 zd?3TWvFjU{-be0!_u_%UEdu9f_5>yp2?<$b5BvS6;y=Xshjad~NCymZ@clY7e=cB` zzZ~e?0QNT;iW>$BGP0mK-Wm1fBXcIQc@ep-_~5OFOcs;u8d|?d(Qzi{qwn<5-ZzV> zF;^O3Jkwp*An1Qvf#%cS=s-}Wqf~kdbdllh%itXb^gh0?2gYcBY>Qa#wyxScj1+qp zOn7i7w0viWo$csjWYIloYf?coQpU@?m<9&xEnCqZJ|DjXMdss;?NvFhzHu{aw`$wa z5L$C?bLuF!ZC*Mg1xEFEJ0N+W_TN`WzcOKV!OiBHl*89sJ?2<84lW+7+jp_-M^?x7 z5l$QaT2XJZXr2zSz|6440lNPjrAQg9ZhjPhJM(B0J%N=S;OPu z9}D+%)EG6)tuG6*d+zjNwCSGe;Mu|M6|Wny=b^EJc2#?To4L@a{v+e-^&Hfwro*XY#k37U`; zDn;)p?f0jR7ucEi6)g3fpGRHTpU*y*kaZW*5bMVq-hkz4+xpyT<^)7DUq$vEDsNtg z#Ic@?u%WLFQb1~ot*u=!*iQ%n=Bj3A-7P~$>(@h7`ZJ2Tp4r;TdHy8>olxmVBuv*C z+$MnDX^zW%4{`x@2`+{F-N26>Nbu235swzjwWc7BK5lAmMu-DCl77@b z+wHwsoyfLHtj_$>OH1t-wq(F|8}4qsZA6EjXmKm z9m@i(ju6(+bv1!aTu65ne?;?#eQ!6bU)sG*UHB)QE%^xSSBBv>Gj_ZzO<2)Q75~5S%{*o5WUgKP$teW%^nHNWFDuewRoZ%072#87 ztxP?mX7@Gb1$tft(1+a;4-Z){P;{}%_P_rV)a8t|0Y!RfcLw-^%l6|9I4aI|W8msO(ccSEyx}Sf^ zx~NUPMK%P?ubZhaXkccIsvkrKc=18;UM>)YCM-wj*4W2j%QLxtC(|xtk9n-hMyhc& zB_~D>lR@aFLg(m|dtg5`+|5HWSN%G#$A9Of<87P0yIAj?YFvngK#7ipcKI1?1sb6M z60zBK`#bE{cef*!;Ta;Qv0NZsNhlekVc9t196?`t-yF%yhA~4~L2Zb1U#eh0*@C+U z?cjH#eZ$P;(QVpdg_ChYJ->*;v*L2HbS6FORJIH?(0HTRnd`Xnynb7MTD(V?+wtAW zg`UTk5^Z&siafb=>5Yo ziq7sCp{og^fdMARP`& z!ynG2St*)z7f}m$(@a+k^vS}ytsaf7m2#2t&?2JXL6?;8^`F=J?Y9BWWCHpEOG&(5 zfW8!Z&{$`wYpZJ`Y}c4Bx0!iTE|X>X_^cJ3cGUe1a#+sE2)l%@VJv`V&-*E%Q!ec$69Si1d2Vd$3{y$o43!zG4DC z8LNMxAb85vD0H&H=u`^ZzJmOC0{Cvy`X~Q3_a!VrTB*DuN}j#+3rkYpKHpcT&nI4Z zuv~v<$adw|lLpgP<*Z6DYK>>U#ytn&C$8ViLm5C@9;c{0%{Ny7_?*UG&68F7RuQcuB2y} zD@At8n$Aj^7Ciji`$$#KmN;3?$ovwfP42mIKAHTUBA*R>JY-h-RGj2=)ne?fTHZwA z$rfAn$F~Uex}1Ga%)F)=%YUn5Z_OUhLhQS!OnhsXGHlvWbVmU%3T}s9G=B|3=zG$} zf<57Y!@Cy8LPyuTGm6v8!f#N9$sMSIYA@Ai_fV}Yye+<`4tC8wwh%_0`Yr^J$XNzt zHRw`fW6c?iwphC1{UDt-Dh=jzlwM{|8b$2b?dV&iT}+iZYps-D$1si^;a@gtk(F<= z8*#Zj2_()}s@!WW4PV!IT(dB!WA{{pcdf5BE@fG_`O}GwqAW0C))9u6G;41@U6(EKUBEC< zd2jj*!~{Cs>DW`JP~HhbNw`rQlw4N-j10I$SlIEYXyR_Z@c_=jn}BAS<+1OETKkje z{{J@V;zyd`{Z9*1z#zSeEgX?x_*3(x67W&i=*6jO&viRj3CgtU-ATK<_as8{=_X4X zyJ1F~Zb|W*z9Ff$^ol@tkIZ@B&FHOc)e0r==hyG7j~yfA>wm1aJ+8T(b5tO6^{C60 zbJrKor1eIu%WSh%eB{-pB$p;+iX;yM>Cy>d=J^>rPI0oxigWI;7_Pmx^^9OmLGNPeaqQ z!DK}OjwPatVHZZD!7$98s++rwR=aAWfi$@#B|&gaKIFvkEJ%skh1L>^GBMrf3sl#D zox+XF2roMhv?u)x9UbqDT>GtG^F6Ym*N(+*=F_H2R?pXlBrGJ|oFMyru5TZC*DHBz zZjd+akfPQwahcrnz~-n>h&=*y07mxayW9uT57u)%)B-u2nsRdlU^~2}x?se#;Eid2 zkd6e%DSPZiC&z!D?en!Y&L7C<~B@cWo6AYUh6~IPvRHIr=7g?4b&s6o7yVQ4x{qmRS;&xGK zM??Oaj??-1bMu88)0xq!*HU}1bBJs&>h2{yQP;zK^a&?w#4uCyvnO;H-;y^ec`n~! z;3cPP%Rz^6CW4@i32W}=Zrp%j*kK;IaE&|+oAYC*MTs+fLw%hL)PG$s!PkJc?rK7M zQmFOPX!(GvVp;CITZa4dfm0sc;{0xRbgdA!gLvlX@G{R^RcX=^#Euxu%Ovu(S;NAlYAxrOBzCEyc6 z*+oc&fneQMbL>I(lpOTZo|sA|kr@U}Jr{1>8$lzi-jQTMzfb*mar%ThlDEAZX_E7K z+|XTOnHP|%5Mf%eknBJZ*0Ca-Tszjv_v5!IWOP#PR3?EmPiPc9={bx8gH*n97{rnatKSV2HUKt)ACu!D*LMIiLDQ4vC~QUWM7 zv`Fs>f`ScDY0^<3^lE5o=l`!6`x`(v`MYh`B4 zF-N`cG0Ua0EtZXkISPYR%0Lea#T&nbUbMLXMXkC9(ND zogXq|C0#wrjix@IDI2+{DOQ&3WX-QI|2}jgY|R+zu6wm^%-Oh()A%~vxeXDbLEGxZ zA{I^BND}u-IP*)*-k<3nZkPLL->JG2w(OkxVf5~-+}yrmy@|d)w3UW?sWin0Q!x0s zhW-kCrOSxVD*=&M6U;_Ph}+i)ZF@1UN(CCpga^cLa%M#!V> zHwnaT-o5gueo=nYB%QC-kOWcY#Ji)emQVgpxW8Q#Q2=o5zO_yY(SsJ0>nt_w+ZPWg&D8pnvom z?1G+#c-3eo<>o-#9bcE^KiqPHDO#GE3eI`onS!(= zY10_{sYPYZZYYAUhTt<2bSoyh&4{UCq1qMg>8E^ zY9mFqY+vz6=>IgE3FW+-4Y&~?`pmQoHvb1iU>{qRz=2LGrK z-Kx@%N%xj4ht`S5c0Wjq7F~h+0`Y96e?!Fm{`l}d(COwDvQt|gTph?}aFY18Of^Zi zAh7wpu&{FbcrAs0R&>u@26C{=M(*Y0wL0`Ed28xB!}q#CE}CNPeuB?Q@ZUzf-2{fR zB|YiHn#E?yjy0Z;Uh0NE&&mg)$o1Wpf&3hy`V8)W^l$)hWF=rm?9-ol4wbfcq~Sv< zJj~d?z>UrmpS~1~1@k8xJHY1Zx=wTpNImr_0%p zXVSm_jev5&-wHZ^3hN*MrIb(xZ~ZM;{PWp8F`(k(7&(Lf=kM)f`>PMyYWr``+JTx< zlJ088zfI~prwqJwb>t_{zlkFi$R*!$XA%AZgacaVPXLuVktH1Z_iEYi;{BxrK#tPQ zzE=O-OQ3lPy!5lLgVeu0a|EUr>WBsD|J!)LBLEoIJjiSDUnXvyd#wuutL+E6VSlr= zf7-3jzdO?1vDm*Eu|Ge))du99I;H^n9d3TQ{1_m2cEn{i=HFhs@SBPc5q|gIZ55jX z#*R7ud)wTn8EY;+YrpPjhkre>?zj+h$umtxG6e}sl2r1TJf#5898Is=-JK_5m;3Hc z?;S{H))+f??hM>#twsexYCSCXzJKX^aaPPAWm8xVg3?XR+q_7-L(ca_YC#hW&!>M{ zR-xwwvYK1dlpB27OQ2aFJ)KVOf8#$-TZo^hm1d<;M$~mqN(q@=r}LjlTob^_;sR$^ z_;*8}q!hTa(ob?*GXlLQxhAFnVx4jAkEFi(=GZs#9^cxw1AZMJs`hXE-Q^Vxo?U)T zBPzXOP~8=RR$u?-iitMSkPk$nGXE0R>Id}~htbYmOf%fxvQ~+TC}K>q$dYl*eaLhA z^HZL_a+5#@lb!1PsUkVh$P0$c0^b?s>vY=L8(kKqt`7kG87(_g>7770gY3BDw56Oo zDaF3(YMz|09Vfzanz){`}#cJOCV1>QtBNy7SOs z(DPS3!SOrQvh^2aiKH|B2geURqqWl#kCT`EH@hl(qj$={;KaL|@JE~RUj&Vb>{_l) zXfov}<~rZR{>S!+XsTLuC{ERo8g7+mzdyK2)0*GrwAr2%$J<*y^J@0>9^@**K{O|R zh_G3WJ?6?mCtnz5p&I1=cqZ}J!nx6Zc!a(9Gc3wG_4v4;>u*$K$foclQ9V4g>5}EI zTl6xp#qAD3;g71#h&h=K7BTyPmHyhju=D<+H>)AN0Z6T_d3h@to&x~qd3T`=%P+#T z_9@YFes^RQXfdy!;D#&wTshgx1cRDN0+&yKkb)N<=;cg#SSSA}p@&-MzH(Sm!qhBL z-MceJ^}ptguzJ?Dr^`|eSA?MFtZ+Zy)!A0sDR!>2HpL$&n`l+JWcKj z{JMqJ_Yziv9>!Jxmv*JVAp0h#XxaN#=KU(4vb_e6{8Dmd`>XtdNrRmPrjcjk6ikqTOSIDe4mG>rkw7RH<#FZLJsi!K)p!dn$^4 zE&er8^WIee^m50)`QgyVz-*zC$;8R-6s?Bol!fx5B2KGr*9-!UHCReMhX>g_EXA#q zTgMt2t8G=ebt+EPkxxPXP%E~iwYpzc^%bL#1#Fn^JJ&4NXAUWZZ9gj|)el`szZDuV z!RryCK`a}M^?$Xw%L>E47ByGV^HVXuDiE%>%apLn%P~s%J(UdMb!*qwrpd2iR&kL` z>y~%p;F-MDRYo$7pEx#ue37vfx(v)*5Oz2{=j||W1HD*SHA3zF`eO*+938uO>WDSkl^e)wn*#EZ@=>k1)FMXhSfv$2d>!8zeY_izbCBGNjayx%)Kgw%4=VuZGM9-=X+Se#}|+_x74?oI>qn;*FHhF=W^kZpzU1csuy(q!MYmS90yuwQE+6uFF0_SNh!4rXNbGKYxb;_1Nh2l3( z%F1JR>V{}cCLDZRcoUE(~9EA0_Q z`K{~&OG5L<=L27MFw#*h&S50i{LMA$%1HivXm=O1@iJa0aHETqz8i}VR-pAzwBm~> zxh1hH2G;$w*D~`i3Kr!V0IKm$gAQ2>htKsBrpIL#Q_vWznjyDM=pT6dD}Wnqr4_il zThK_9I$mmbkIg2dXIrI&$v2;JbZ)}}TO4UxWTQI9#0}!w20C!~76MAoAuPK|pV3LE zJz(YKR{E#^e#Y?_fXzYHBm<^^r%uN6NPl{eoY(L*_UKpATgCUwU#+3EC=;>tMd1?%L2~9U-`^Pl_~KvI zUk-j%WjVjC!ogZFeWlte4x^&3{vNdYup7>iyM5tb;7IJRE>fD6#yj|a2EQdEpxx}+ zLEm($;Af?QeT`lZ(y@FMO+WQH`GW1@vgOAEPldlS2QA-Z)5OQ_HxFCeyp*~L|2boR zn=4`|8|LX*jXWPd-XNYw`7~Zmd(P*V@P`@EAC-U$`wDT_q9X% z)Oh&Gg2SYD$rUyivkU3w{0L!JH*boFaig;tu`?uMT@{XVKj7)bktSO%E^d%jYa6uM z>JGj15t6gZ)XFYGzAJmA^aOx58he>GfBP2SDohIJs+3zfK~CPC30`!uQ;IV&eQKAP zh3vBuTwW2`*cYO{0OrEZgs9ESg|An|+@^U9NXb4DHoPChHeo6v$Z8l-&ZD?^ZSog) z&C^O$_IRdTt`w~pG&V3BZ;X+V2=K1$GaNI()A~7L|802_dC&Z)^pw!8l#ka|dlH!8 z#hO42rul0*ob!H32yUeLpxciV!|?6Gs{P3L`G7$@n5wo&Mm?JMRO_1B6D79w(td{K zwpk)emf8k4b_30mbf%p41Svx4VMr8JM`R!G>9q%+@Y%b8aQ>;2i^!24|M{LN*@>{n z%!-6vD4eNEdRXKhIa_q*)bIu=&IIm4n@Co9{O37JXLEi=2rwq`ltpom}_;{Pz9g0AC74$;@n) z+CIY?alp}MIy0?@RR(mbouAXlj@QMvZsj5CW><2&SdY8BmbQ#fGXmk0F%#@eKIHCN z%v5ewHZZTiy`%Ej?=0b5K2KhuIwa=WwBR?F?4U2(6*(C3)|d%Z@URh!NDEzdT^>f^ z>^#CKK80=5eXJvcQ$Mtk%?*#nntB5?oeTu#fOeFH64Gn&XgwTIy=--Y#A3eOh?} zQ%lQsGhUm#(Yhz~DTfz1Mohl>2V&nWmhgQq3Tt}Glp*(sG5;t*X=y(^^=4g!K)xzRYM zt=e04w7Inp6t%llwVctQ(0Bf-Q1cjdOczG*HThP5-KU`yjXHG*O*Cv`>HQ$qLlLFz z`*i+%B?;rQiKSMDl;o3yXBSx!z5Ya#ESmJrh1A}XFk8V8{!xA0B^VC@5h72rBgrZX5O4( zEs{B!jt`JNt!Zgk%^g2-`}R%4s+CIq(?0^8XS$SqKVNoNtCP7bm7K=q1`;Wb z%D%fjPRf*UTU>cro_m=M-Qf?)&)1YAia_nkV&a-4$LsQDOf5}xdNPS=@zv=`Rl!8% zC!yakGmqES$J?^qe3}jMw$NT*hdA!!hVX;n>8y76J;K41#Dj9qILAB`U<36OWtie@}%X%_B0<}@R2Q^8nxWV*St>TgN@L8fS?O^~ zB4@Fbh|C3fLI2YXC13(D`cgg}8f|xb)~ARQl$tN4?YG*!ad&}zSLl=iW6~jVUksAr zi)8nM@@~z`+CXd@!+Yn7LjItxSo$dhf^5AI9f)&wkQbSLBjcERrRNEuJS_0UmUsdl zhKr$h!tTn(u1|FgDbtB*9$n`_WuaJZXN*Q?+Pkg@o%Dr9T#p~IaFs`cg_)Q!s(3S? z`&=H2q9ZLnFazf0ka9GombQ`O9$GXbh_&0*_6C$pnlLqEku>9xE(O+8%dD9`f2L<$ zgsf;pe3V&07x3o|T=>r{YIW`7S8nbH@p9UXAm1^f%E1B-(fpPC2dsXuJ|i>}P%-={ zq=Nts)*JKV{Pg=Cl~b|&i37RWlNm!s=qk?_;ud(~*devBnC>J7#$T?vmrw3s`A(0<+2oJdpfn;t~jgW@4v$HRee4lVU#w{p{kY|cLV zG0rtK|8bX$%!xe|pclp{%W+HL6b;Gt^)dWv)?J_t$4VF|Ggkcl7N0$Crlf!V7FbL4 zE;9!+i)Q>SJaJT7^#ot%B1JoMtElLYptkTiq{&KZ$_4&+DHjzNYdiFPe!Su0KxWI{ z$j^^}YI{-!%a2Upbwd^UFUh|4-|FJVs06z4qDaI*+EasFAv$+FYbLbc8xxP?icQ3P-S8q_yFRtUT9!e$wku=K7il+13_&rQ!-@wQfQIFv>K2h0R zp79gwkdVtGm*#z#?0*EYY!v5ICzM|;>@G)};tQ^E&z|KEpY3yd?bUOQBZN>AmAtQK z{?+oHcgJi&@(mvm5y$l#6WLMY8`e=btTHvYR8DGg+8#e3wsdccCT5;g71>z7{bkEg#TT_L03+jBM{`%I_UEm$Abgi;o4DsqwBru^w;#!mM1H>GGc6_s88GC zP>%j3|-63sclnffVFB9lTo za3MW-DNS+Vk$MLltPgRTlU26qG^J@k#xcfYpHGOWK!)rOHAI=bo|$R0epTcP%S zK;X!paEa-X_6}HXoC`raQUVq>GNX+I>~URSHMbZjEqC4>N!PDiD(t4{U97cI)Z;3v zEgZN%@`$V#IQ;f>+F8)^oB<|PEG(laZIyCQFEul6mgkUdSz%=vsh=h#cxOoYUP9Ibm zo-y4kq!q+{)g2EMbg9%NUZ70>w5%&EW51>r$r6{Zng{Kn=`d>3g0KwG30zdJ?g{)tzL7iY+%Cum_yV_CP;+>0O!LiHyQ=2ZG#SCJIx_ z=UridP-MdMKF-PfG9)->scmnVaJ+c2zSrNhJ#B@xhRik?2Zzzvb^Ylol3DT`N9{&+3{{ z{71f_X(iIacGC`zN4tI}r2c!czHgMR0~I_~ED?h=2~4veXv;2lCoGR;k@HHfidesk zYAm1K)MLfn;bn&3HRU#{iwme;pU(q!p5+5!PqR8?7E^evGoW>sHNw!B-}g%@VLtT# z)9En&r60FTjJ0@&vNY4CFQ?d@NPLZ1{Op^LgDI4^L9~E)4!nb|k;$Kgi;S zD~1;Uv#wdl%30!jHhLJiqM|bA9rNcndxB2jHdv0yj+gsM3LL|L$A+02n7gHFw^Rgi ztKTtwx0$?k*#YubCe}|eUxgA*+e#^ydq&h3J6iB#ZLXPK$v$$aFXkMtYeSy~leaeX z3Q<^=mv6Q}c+cLrUNP7Dt{TI>ef9w(>a7|g^z`t3ZxA8Duy{P$dbtW*GA>+GAN(kG zJQ{w|#IrkF6wud{KtNv^(Kj{U>b#iq6B+4**AqMUYu@GJcMr#MHWSM>S6IVhZT0Dc zH4AUG)xW86F*dACw(8230t-!wo9zZUUZKA~UC@&`Q^-?ri(tBh88Y=HoKM(`A@q8a z#XT?HE9sV$!!CzAi2j7y>(9hDxJ4{IHN{itV-p(wdaN_V;BgJe^@c4XU~lXW$?O>l z=ubQ^uuTMyracs=6WKDyx{~~693I#N?!A>l+)&7{C^IfLd+C3W)%v+(zMfO-WZHbw zu;GpYD!hhYk8V(&nfgduAF2w3Iaj(3I-_n8SHN*l!Aar@GiM;w=Hgh9ZP<247crdb2c|US8b{er7R$D+7*~ zvD^kvaozD#;f;eOd4a|!huseqq_hVC#gMwlDP=_dwDGxrMaE|K64f*GmfH7={X3&1HPI5 z+we#UV2bc=J~QeB5!w6JZuggdj6895vt;crUbp)5BUg^@2Q9_zrV5G;vwr|r)5}(# zcdPwj74p62!I6RJXr#l0+A1CXnn69ZyKHe;Cn*3U^J~-(1<{<@!FFXj4lni1pJbBm zmemga9HBO(zt<0~`3Qy4H9i-{D5<@Z`6P49w#{_srO=+Ro?6ZnKKPZD)PM}DRnbe- zCgMWa$9HbROsYKp1SYIl*jNq3Sk}4ygx#wAxMk3e-^84b%o8FckPqWoP+UG1ccC$l*J0z3JO%o-@R&rUDvvw}}vIBRl)7)~4qT5k*ZEFjmT)b*wZ3-5LCNR0N zr3>Ei8xg*5uC^B~t=|Tfz+97l*2U7nsK-tgo?>p4mltx9mUfDEUOANKYt-bu=QAQI zD_#7B|158gs77e3gBhP~QBN`(^kcYKiu2hk<5M46c`j0zTe-Dw+|nB3=$_&Yc!Q$B zRO)o&`Zhu8=g{vQm2Gn>);;QnL2k%Eacy9m3Tat%DD^4cqj)8i6KyQJT|P%Qd(4PP zrZ_tmhuzjQu<#Lg+o`9W^hVrDLlpn1K$%*#Gq0!5kHjSbwv(AT;y{CXbk~iKIb-lI zy}}v&c%|J)11?}ISkcC2HFXkYtZt}FOMbJlWutpg|4S=1C}X)i!HBrJTK(!T#E#+H z13I_WJCZKF2(|y9^Ck~dwMHs=mX4DwAiJHd!fAaqg%v=g{){*Mvd+Hq88|nR?uDOB zD*2oPW<_z?xJGdiu!I_htg`zJ_swmXaA_ zgni}9kf0vl2ItLrl*pUQ&0$NYKKqZ1f$KAu_3BUyDc7j%R#JKym%6dkG%~dT1;R}q z^;~NR!!nk+*1t`3|Lk3D2`r8gtSd*HZ1opUn3&h$i#{8TrVfHo;TJ4~zI5jzh+H3w z%_KUM3Aal4mPqKgx$*Knh(Oj??n8o8fEqk=z`fsJ25f$pj#^D|Jtw!#m|?dk2x?t! zV~M;;C*$K#5>HdmA5sl}TavRiv8IF(|B(t5atqcbF4HPv3x>YFpE8g$xR5Y6zdkA%LI$Dh_yBSn}4+fCB)d4pZi^ZJ0%-M zUygJFg01xK|9Gp*X6I(ut&HFwC(e{UN02-M&|`cdfM6XDgxG?KyAAgry;Ec6taaaSNEd%2VPZ*KRf| zn9*-Y4)qe5Qdi~*XP(QgFM#W94ckxR{p`g6+toSup@UU+4FxYHrFWgJ9SV^s@(d{* zez>6{_ma6Y&4u2ZW0%5yk~wJCvSi#>Kv_;d+p}IGEAk+uZ~iCFzYpUTNzw0$K7a0q+vd%{&Zu;e1poa_>JTAlP8@ z)9e;R4J?ymcB<`rcMRnlI(@X*iAQ0szJ=_%I%lUq=F<)okl$>H_nepsIY(Q<)Gb*JiS(O-Oe(&v6y9>Lv2MAN`95s?!&m7q)WqBtZ!I8s+zx7;Rx+!pt#7`h_Ik`h zfl4~{J+Dp`N%@aL#AA>gN$1vie<2J2E07M;lPHe4ffQZ_RqFc=MDM9ba2nj@T@sXO zU9KphFw_mi_Lp_*k*t@S2D0)(GQ)iwNmrO8#BU?V$){j%H&;!|8ZRC44)3V&{7{&} zhfrS-Cfp_ZgDJ2Au>0`skaXodp}m~@K+!WehSEoeooMxMQ+eW!nNt*6je0d6bDq_t zJ5bqVr}O>_n^hNt=AhYS(3k~V49CH!Dwz#PQNiQy24u*F!2ajU&a^f7)Nl(ew;oD6tKnaFy+ZdD@PKbfZ+C8b5=XP-1l4|PC065^`HaMx? z@z*;h>MU60gaN}9AndkR`Co0I7-MpfBm4A=uf-tfk>jG_P}M^d1pLWprJglHAimKL ze;TU#mo>lKY!wmq#kFffE1nE)f=_&6nM%zqRB(IVyyv{D0UP`J# zGDPHhsP*7b3*-JJ%ZaUx0=43Zj323RXMWDZ!FvwJqVs&+VQU&aoR{+ z?krSw#5otgk%2WO$$0gjb84Z^t&e#f;=$aEkEE7B{1-+v_!b)s`X5&5M9jYElHZe~ zr_P9f2MTL2g6glatXd6HAuq@hql-$nokJ(;76){E7zDzK-OFe9wlqG^xthh%&j$DD z^WkH+NE+HFZXDuzDb4K)OIZMdjbd^@v8^m4;)&#J%5^G9u{Vcw&;)aRgwar*8w)ZB zn*cG~0C#!DvB!ftXE7ySF{A1dLx35Wt(UCirNIdB8Ic5t9HTa%Z0XcpB5$2t9^sIXjXER+ zVpemD6pT;Jk)Cz9F&YvA(lG29ixkFWP?YR2!s)cpY%zXi#b&WGeqKT7qh!^oD#Mg+|52Q)e^5(Ghrn?6S<+!GySzQN@-g7SWjQE zL`ykt)XOBwEj%Ps)Pur$J0IO|cNbrP*|BpBnG;rim;tppyGZS9pbW-z_0;-D$6-e0 z3`-_B%zAsBMqV$Up_b^)t{W|B!p`Y!6wJ*&n!eg5rYyh9Kd5LIWtFK^%TpZV#{Fpl z-k>zwZj{n~DQ7C>!n%@8kDp&p*qn6`(H^V6!EU9vOxrHPJAl?cEUC@q%uKwj(A9Bk zY2|mF^Fi3_br<+{$s5&fMs|kiVV0I-*u*qaFgVXP?fSw=TYZ>O14#bEP} z-V{iVKY2h3p@j4f71|Q0A3|RQZ*){FSY<+kG#Ao}H@ke1jw|c}vuZS)m^t;u zfgcj|Jhx+8>ZBjCMdiqX^j!2`;WQ@G6iN6M;uy-eBRb4C8373u&rnO#V%1I2>fbG6 zau*t!)!IJq2jOYfjPyrNES`iee0(RQP-!K!Urf+H4pqHn_ht6`OlI)grKI60h#GK5 zAirIUe_Cz+?q^5^iCzX&^xy7U4-T{+{tN$^c<^xsP?*HN$$Uh8Un`g%8TZ1@tr?jk zIomot-j)N2X-A}P6Dicandr#AfR3GP z1WY<}v{^>FV!&V+J$yO$t%79dqe>lul23T1Z?p>5+DQ+ z;yTkCN}Zs8Km_`Xj|ZmK)qC~Can#yTmYQ&15v&#i$MIiZ18PT)$JehL6SnR@v>zxF zW?r8?v$vhl-N{S4s4)yxT!uk}ye_0aGmq-)GaBZ};)8B^!P(5)J=??or@DHYVX$!@ z>vm#isjfz2tWOF^bD5Dz#$jtwyqIUTSJ4Sqxh=6)X7m8tvu@KrGE;zBQ%?T=3?t&m zu~YM(t&B~CNw(`9)#naQ&D=cG)8{W5J zRhmj6pf#39xl-C&&V;*AU*A<>0&KT&FkqH?UXM#fUvXC97_*a}PxH%4KK8SAZm_m- z7wF<#PM`!!JtD|_V6#%h=KNU;_Wr@}y-ql0g^3?JQ?k0re1QnhbB^_2dQc|)Sld%~ z7%I+4xr~8AEoj}H#0A#{^Ty#AH{MDdYn(bp6Eu6OoF2BY^${BvLxV!{YevH@hPo0} zt?FH$gWfmV_g)~I-gtsEL0mlzMM@EHwzqt<+$s^RGj>C7Z-&IpJ^FkzCY2h<-S=YS zE1aSOF<2tMkA;?{2lwXD*cG=QKlQ`z=JUA1u7a?48yExOb5#c7Mb-t$WI=MYT;^DG zm&jJ4CjT%owsrS#XaT0~*+zOVud{GZpG>tv%-&niv}D}&FnKTB)ev7k7vx+XwzZSO ztwI0np$Vxghzi*EVdfcM2*UO1w_RsCYmX5hChg$-htiYb#TLHze0TaRe^-6ho6!ay z!y#pZ^f+=LxqXj(&4u*L_j3Ir+cbVv)}~r_ z6KtFKR+)hE{n?Sxzq^bGi&yBEbFqcBA5Dr)uhI=s1MYs$irEU_N8t?O$h z!qsuxtS&kJVYA2v4wX_4o@m_m(*6cZqkNN*CckWEXRRcWUYg+P&w&)d-fXI*ytX&S zq)*j1=lKEJ-%~oI_F}8@e$NrF4c(OZ^cW9ztL}7gx|Dv{#q%%6xmx_ddCV6@UQDvI zccWMQwL4RN&vsw=^6fT{7Rvag*+DP5rTXmus^JkWqi5$ms|KXcb)B`I69ImRxKdg zNko0lt7Y`xb?g? zYuZKH^=h3&OgsPQK^$>{PHed(OWceE( zF?@Od($pnZm@m)M?nWTZg@Okt=z38v`cQ@@a8HNkGGdI9q9NJ2>Qb+W%vgv+y(xc^ z+y&I-HvR?_=$ZKgpeK+(q zIV9E<8>_nNYOMvw-I5IwUgoPEy@ZB;Y%E&t9opKPMlHBxpczwuR%hXM(%nWY-GvmN zkR*LNPEw0tn++b%^u)=$vB=y7i}u3>XTk4G4b>rpftV`s?BJWTD&3Ui|&uIAEJvMooy>xfaE%trL}O1GO1_%{~v)C1Aa#in z)`RHo!Jg#pzT(?V;Wgkn36)j1lKS?66-FHb8z{AerpdvsH!hBhFr8PB+uV(=f2!=S z+K=yn8(VM)H@cIFuHj_k+39a-1MYc|FrS7d9Y} zc|V|mQI>Cp)=B3Bk{U%R@}C`S`RVyE4T^+piQJW7pi4|zN!_bE-!@M;jdEO6;UDUp zv*D|^#z-RFdSAN*s$MZV@bB*1+*f{!v z+Sa76Hvh8Khsjbx9567l{7t%7BT*8utKIgKl4@hEZN^7QmyJj-)!zxBN4X6B}|Av_DJ{kj-6b9zY;fG>h`-6^jggZ&DA>uZ^^WAS%AFGDNSX1i zCx=3Y}8Poi{lT4BuMDuyGL zj;+rx&N4R?QnZ8cF=PU9;kU|{9?x3OeHJQjoa+Mef=4x9>q$XVHQ=e=MeDD*qPPjv zgp@@hQG~eN$jMp5`=L;yu3|dG)|IBP&G$oN-pR5gmJ;@M8V`iNv!E&+F1= zoBi4qr^k<3&J9Yv3Udh+A#ON4-U+Q6a?ba(wj1BNMwqgjf$a;Z+EJ?RH@!I8WPI6r zv%`$%x+__JL$*FgWiSb3-D(~@INx|j)>U@y&dZc%oCNA_$-vqs+~9%d$NEugM_)b| z40C5X|NDy*c%3CH*+o1r@1Ey3?|}`?lJ9Q&w&1><{q$2&HgLJzDsd{^>JY!lHbEO@>b_FT(zd^>a>QKbw{1T9q{0!NLei z^mFr<%9~#<-YHq%0aBsPgkB<9$TYRbR=eifFXYWx60FRvbm_Hgj!r0yD!fTlcD(^9 z5!Sz@VmvoSlW`G$$3p8Qnkx*x|Bb3yQ58whfi!s*TdS^rxfO7loSeLV&BXbZ64Q=Z zpi&WsT@D~wK22_#58rCnSP76kJ8av1kKo!Q;VCo#$+Av1_^*ZL$a5d*xu&lb)pYK4 zF53pu_KHP(<7HQCebQ2IRt8#e%nr!_QM%JWc3}+9%0Q#$5BAPS!+Y=6)OdS>T}6dt zJL++lJNqOx@SQ+afwy7h?Q?Zv@0(lP-ibfs_fCt9#NNx~v^D-?G)9Ub0Mx4BN2-$4QlIr;*~OWx z;D_Jcp2IAh#r}(|UwQPvL08WMesa&%wNKoK32h1sOHB;H{t9mA*$yYt& z7dk3%ydh8ekLeFfxUieB6;IfDdgRW*1a{(`-7bDLLFp$1>hdQG`SnLX_3w$ME)Yv3 zNOEK=#ni1&hf3bhv0UqZ{ufJsvSHu;GG(>>Kf@2aFjkMcI;>>j&717nXqg7)#dyx< z#CE!mmEQV02jWSQ#az(Sl1Hsz!FfM@5xs|K)76!{q*gX=l20$l5y~FXX44s=;5$4d*3 zM3q9Q1J7{(cjK%G^W=!qe|pXa@yeSzE((`*U<%K9SwH3?1|b6C?FF}R_kPmZLzXX+ zz$CE;RzZ`5Zrtk>+tkDx4gMw2d?379L>KxAoaBpL#M@cGa8Q%ru{Ye(@X_w~4IJ@< zg+@?)pzmneux`;XwM926H>`Td@w@KlVObHkIO^ka)vVa`bM<)GSu_$1tMyEH;^a38 zgp$eKsw|z+v~}DMyGldzcT34q7W%brmH8gz`u8$G7gY%C_8Og~_F!{fRvPFOI}P%y zwJ$2DwM%uRK!DnON~^W(YXJ71q7p#5bIt5Sl@jIE%HQ_ttCl_U^VI20=WY55zJmbV zP)<eZZUb`5^Mg%f%Kk}R1ZQ7&Y?ddT^Cr-XT;K)jOj`5?hA8h6_nv9dtQES?R-<(?$iS|&+BZgJ>NR^~hgiDD+e%#A9+0?dPlysS=jQW*z5dv#o|9c$DFQbG$sCqla@E)m0%^-`MUyJqPibffgxikKAN4-mS&mWAZZ5>sxNEa; z*d^&XHY;}`Q!*+#R_~gbS*`AA*nND~Y%LBv$6A}omIKl3>bgWG)lFheVvx)oElK>t z#8R0zFz{@M)ir%qXBs0n4D4Q;?xYq-4(3u=%F7i%-HiNODEq1PL6QTYF$4_S38s`VJ1$$l;V^WM|WHh5}x|?p?d^e1RXeoR`H=K}tQgX(v z=JQcaNuHC8g$n#+yNm5xfRiGqOOSGi;Ya5e_Hm%I!pF^mcWT%UT;wJ`sT*1gV*K$83~5@SZo8(%~-cK$rc*tA(n1 z=gAy<;pW4*zmJfqJj(Hl6TRH95YX^&4CAs9dNxRRYq|gOc_MJ*!)xXJ2OCSg7Oyw9Lm2i_%19 zR0ZF9nVsZfc(ez(@O>VS>!z@b^m|9Ml4Q{2B?6~KP|t@%Mn#k2gQ5Q^9Fw-`vkP8& z_oo0{w&$EA^4CjLGb0~=ok#39p4u1})?l9@_4fnj;qkbBf7wiSsMTopZh7Z2N4TVR zv2nd)`$JfR?=2-fIV-fiC0^x(JMp0F*M~X{hR=Cjcg)sCM&0KwfSiuYPU@&bAVyHX zot`JqM@y#phg=yRA<}08HhH-h4hsi8H!Z5Z^H~NgJ%x?eb)d77``p}%O_zrsa#>=X zW2quHMnKML>7E~JiXbCUp?7XC|I_gM{{=nyLVYB{T!Vg#Srs$&OBK8L&?O_d{BZq+ zwN#aX-2-Uj_AlwSKv!vaFo|MohJV?`6EZ~DdS8B%_e0}*6ijAx<;@MKIz(8j!lEM1 zT6X+nK&MdO`|yP)Fy_4n<_i6O;@F*XWhRxUSq#lv;*HX=18y)fPVPAbo-AJq;uQ(< zetlQW?nB74{>_?#yJaCiAGR$y(U;PUzupiqP5#@=o9%9nLl<-Mv1dj7KB=yETG$Qk zxzAk(<)3glmvchv>ZbJNYdQYZajx$dQQmT3G|;nB7=Py#Z4S9) zT&if=`#_G(qMyA4rtHGg`#6?__m@RJ>Fbs<+F!<_Yi(elycxMC1ILlwL0FlP`^X&v zbtG^u=jh`nwcvp=2-glJlm7tWg@d}pH=8u6f^5H6i`5&L))`|Cv>1Lf>lJc-=Umb> z$x~t`%lnTTS#v1^CB%33V;k$e)YETx7aOVQ<0DVSe%1!(zwkQtPhY_Ed#x=o(5rQ$ z)#bt2La5fCJW>X4hih`(1Me&W(Z`jfZGw)Cx_c_@;=*XmpnpoyVXZSGCJ5_B^Q`c- z0rfjk>iLkA7a~1-8G|+i)arW*L>anA3er~zx&dF-+oYeA3$VM z4P3s9&{WS{wh;271!ioly@~D|qAKr!SX?pQb)T3QcbPz(g6{ue@4vs{Y`->OJe7zb5haL{2ol0X zk4^*;EkuhRy^G#W5Zt~AMmc{ z7b}*mtDM(9_qq2zj(u#sopvQkqc0@0K;8OW)OsfraW#hl(cr+Q*FDY*EVbpxvEu1G zN!>DH=FU~QtM2N-+FYkAv=d$g_ViwM%RqpusdQkgl}DqJfUTTvd zzc-UG(wDxY96h(h}})5}DJzTz(NP04}>0pCdsbDIi&m9{Hda0ss|y zl?@{nvOps)@peOOxd)y6czrd|EvAe&h|Tpb@$=^dZ0O9bW(0S>jS`BFY2x_s+TA5Dtr>Xw0$M7q9=cm}%TR?AGj`~qDw@2ayFgY`# zd70br=R7epgrd-&@@Z)S6xwfETc}Swu|M#3r0rp4`)}<|C~p_>tEL)@mH(0$sRl`% zjIFGt?M6qdYy4LFO`4Ws#9smfmgu6e*Z)!Z35@2BvyrwtHKQ2l_9r-KtR*A2lh1tE zr@!=@X91i6^^DHgiRi!^e%2`=GH_ z*R=Q@f>xz6z(1b!%&39t9WUR0fS`PL zo^@l&uwf9NhrysMJhyx__GVW7R9pSM@4Y z{S;NjjvHCfh`dD-j!gO}yfIX0GS%uZ-esl#IDr**cQnF0T%!6r5fr+azVN)&?v{}n z52K4<_Q8;+R4>4jO#SfDH_JbQTSgl|DRq3-+9*~Qf2(nnF$>mMphWk;YZ>e-0~~}K zI)vueq0!BfInm``58Ts)tQU5EVe?-c?-kR$7yZL%X8MY0C~+Su#zMRkuDHM0~i#ZYZ`x-K5+2NjnxmHG0Ef8prpSF-;GH!id5m7g>yXX?xTFc7`=`_~%V;_sRqwlR^fV!Gt<>m-crX8X67SE73KW z_!{*qdTcANYMB2SEV10yH`%Ds0t6uIsv)4k>wr!I*HnqQwrt6>24l+chuK<`F%R+o zscQePA9N&TXJ=~fs=Van(Nutfqn-T&i-AO*vgJKK#w&W>-ZQg*mYZkp6+j&N>5hL`|4kx$ltI|+Giak{2^s0trvKnn@_`5 zJI)joWkosKpAtp=&ut-{oljz&u2-te`upUaZX2_$Qz$}PTW;cpxPvA2Hl3_==?4i# zvVXX&i(j+<0xHtfywCdnr2>9~ssi}Jod=Hu|9A~xzRg1#mTax>-yZ$TC}x&7jX**E zCOl#CkLLu+;1Rk&mH*DwgnyZc{ZV=mfDSkf)HMFL;N9Psc??XT(v!QTy!Xc!2EJPe zP_F;Km;C?6m#iAQqL&5cul#WM>0c};Q2fqJj!m2R?8G|iQ8qQEQ}a*r%$@=4=wvMm z9Dx~oVD@kJa^urAAw81vH-idEaI0jitg z(NF%|tUxd#EsciJjC{rzo_)X7v=hBU>Eb)xK9qk*KyoOXUHf16`Om$NDuJ`~4E{@` zrtRy;=`mlyw={L&)ePk=oIc1w!IY3nfyFPdByM z9~#E5W2D0=to;urT?C`hqQ_%fKf{@qkwG{hvH zXyr#nb=YKyhN@AfkPef#YqFn+XA{|#4M|L^mX=7i`_+whbaIF2_5iPr8qE-Xs~d(` zLAf0kONvgG8W~kc6VZz8?)=mjYcM{h+OpULqAbL-N_bX+ zf@4uy{Yl3SlhZM6nR~Q~$A(wUoMP5LKQj*Ylx0fg8EHK?>)ikP*#kL6Nk*hyzV9?T z%1v7*)$j$Wy$wDSOEtX$CS=Rh48+d7bIaI$wzxMu4xOi2>~q;cFZ8c-NGYXBu54!3 z$b}5W7xMo(b~gedZA1jsbJBlHIKn!m;?Cls3bMg^Amdq;5=~As2p)zk>MzY2RMWMJ zEfid?AVqK}Pkh!lI@NIWAq;%lNShbS!zGLtOlz@C#w&9~`SL$@NUZu0affXFK9aZk zlaA)4^(aSVKc>)!Lm9hL?RfTeV`tw8uSfMa&+>B5) z!gF9gx8Zw~aP%jF)vd__x~i9YpA=>V3!hk1%o3Yd(>p_rNmyX_!r6Rd?u#f|5};4t z&n_vmlw^^-+Q`PdX7oOIG`8uKN*-%e)38-F)m#E@cGSG|I6=UeZf;2PL79op?C8g7 zYKnlTYALp%spRyxTk{SxYl`6>@7VE6dy=N7MSDM&ckT*R7JPF=Pw~7*RN4{ZgdmR~ z&M84=b}4>+Pc(aKP*Xvy7rK@oT?sQqr1_kucPlFNRq7RKZF<0VXY(zf z+{G2#n?w_|+~+Ey2jD07JdK$etAe*`+y%va4(%5DXGr>{=7*(Bd_~F}Sc?su`H%N{ zRtj$}a3}^=w|SPa3TL8zu%!!S7Zfz5O;y?>SDMdO)+zP7)aF#k=kfwooTf*(gcCBqwIgFHnAgY?s7)-bTBUGaS}p=!ON;WsTgJv*F8r+0Dz0+^s^A3yo= z_H`GXteTcBt8ow6=8wtRy!OblLSTM;L1%@OouQZ!Gq~Y-aFYDcRt-iAh zZ+6%qvAMB-`A{vPsBlUtW~RKcPV*vR+ePY92`RLv&pO&t+e(=~8H0ln)-^ zZ+7CMy+0~`4-QJ*cX>XS7~}I;Q}p$O*KFb`!o|N2#0dB3C8s0!j9!ANPRPWD)N`+f zYU1;zh(Y3BVcGqK`bJU*M;QNOB}G-?j0t(@kbtmtFgCVba3C5n609$r_?`o*obuzw zKT8!isEh+!$*d&;Y>M)kFi@3JS%ub2H)!Vef?V39Av|GGjGwmmoiHrDDk}M9nt`Y(NmSd>m>S8zkqj&Mb@y*oaLQG?ClAY;*RL262EXDOPc`1FUuJP|?N2h=n`mAi zrdYO^P|B9Frid_84#pDV6s1cKx<}aRi~;sOw5@V?_v40^Oa7B$YNk`$bai|lK@Ep~ ziU>9j7^eUd2`Cp zhkBcV5}gr@1Eu=qY=Xk}(;l~1TV(3A?XJIs`L;Jk?h0k7NZZAbyur}k$@XzH(Xr7K z6Ok^8Ufh}HXkx5E`eL3qH0bL{@Fkon&fMXr)JmFISs@6wC#b7EN+!oDeF&K_{ga9m zQ3T{fqt4+#ZSAIBowcS4Q)^@J-0mE$3tGvTEq^n}(DB!iXFyyBg_>s`!@jo*#9{fD ztOpcrNqLEL>!Y@2F~`uPlFl~kfnAxM!2Ci7j6hJ(`*IGI>I*nTHusx@J4sNuJsp>` zTH{B`9tE?*tyN+H<* zOe9yK6WYkiz@J?}R=zWdFU~J338`PAW-=0Jdu8MTCtmE^`=Nz@J=DLlwXclhc=CXM zvG;R=`KsCgrDe24d6IST5#ht%VJW)A;bh|9HikZsb*>+MC$p9llxBL}A0uC9QGj{n zzJ6$`G4e5>PE4wtqi`^J#Pa;1zUIu}DVLd)zN4YUx;Jmar8h!sP>q8xUkiqylc`eH zAGeb_Q27R_8Xe0p75A=$N`L)Af7qjxLgP+{D2o~?5|VP}@J&T^Z0$wl(_IJu?$9vz z@IC#%98RbISuXWCV7X|fE_pw0`V_A~Xysx~4j|X6&U*~VTn*kA%Dt)T__CVsiz+?4;h`yx|&sHbwuXDH$ zGK~*6sSRL*bnmcuW4?=n6o?Sd)T$&n;_Ey)FNj6u%l zkwp5NTID86eB~z?HE{A-1zTDs`>Okk&OdGr>{ zesdKry2$d=?yW;0CA?ft-}_gBhmxK)M=QT;;M~z1L{Ua;XyQmoOtCAC`tG!T^$Eq; zxH@opbMaLbXx)mnUC@oOUwCXC%=O?he|#U|6a1jZ_iRTZb$@n*@Cfh!Q=L1?V(H(K z-@v)s0Dnl^@pjKhLA~4o7G!7sJ7Qtk6WgZIG;|Rc*H<4M3|VxmmBm3OGwEnkTF-Dj z3mT|v1p?2Kc+?QtXSpk|zD^5RUu7X<)m~vkmtN94zfsi2_r}Myy_eqnp8kmRv z8!1IX=nj`){bSn9!RLR38OwhGhsJ%8H|G5OfoxpU{Q`7ioSG-<*(T_o3mdzi< zI{@Oj291~)V*$M*Q6`*PHDOnr@&k*Bj+2Wyn*g_xzwano6zw*bqdM-!{^yaf4Om-$ zhMAly>Fs;wK7xMZ(1j%1nd0|a-s|x(Hl?o%^&lJn77hX>y(}{s)tcJ?QwyB$u&@Sf z?dC^yLzTp!EfXcDCYwKo6MmF-ydb&{Ey-8NUdb9UVpoXHq)KacgaW(9Wh$Jzz^0A+ z;Tr#)KP=Bh32-5fj3Afv7t+3(et!KFd);4F3ORnj^5-lI^3^e~$4$|;<2FU2H8#yW zbZ_(f%>P`a%!^f8bAF)n$IAfK@Fzg=py1+-Mjc3uF>c=I0nzd{#kz~gjd8{@eCSUKRbRKVJ4e0xUs$Cm*B z5w8mbBC{vN;13`Mc$NIyK*PY5(7r#H6*w5)0*~`soM-vwzg(6j1Xw$&XUg&bP;-hy z>ZOY9SOLv0va{w1Dz6dS)lvYdGwg~KNcS;6>{LD=MFPI!Pl2{Zivb#uI~zi?#bdUbl+t%rAxfvUIpghs*g)acb4~+9j+R`>3=78d3nCAooJt zqI>w)+Vx2DnJGBZZ>mIHmgt}*duHYHtp|XD7CXSe0s5Z{Q3bVw3)wCf1IhU)r4~>r zyzDb_$ETO4Rw#p-!!0BPWXTs+3_INj(zK^qLT&U>$+D7Ku%0Ww>`1+vII z;WT*mgLD;`ba8fw=2W3~N^+(z`y0fQR=oZA^JQ-TIIq(U+Mp%Z@#-+8Qk34cC3WL{ zmF;7Q!Fwyg1xJ06!>GHtH29Ii3pEuQkdbKv+`5#gdmFQtpay$X2|JD%TKL%BR-lT} zJ5L<~H{}T01tf?_Rrq3!OD)NY_3B)fS1X%Oh*F(i-?T3N=$tp5q41g1F+Usx6Mc6< zUok=J7|ko#YF5%jt>Gce;53d>oyuy8c9jO3FFW_Qzz=TB{ZG^QYu2#+gxAzuR4+=J zK7Ze%<|;V})z@6LYfOFr0qS&;<-PegVtY<5;<{ujXC zsuo{4Vzp>6^o$U%Q2u*FadtjwB0#Sg{R|%nl8X#7YjDpCb$P$TAN2bxsGB?cV2iY} zf1pyO{#_d&UpoFxGxf2m?EASm>Y_8nBwB8Fcg&C{V)lX;;)Wi7;4=2>L&E*k>Vvz2 z(xP79pX*;QT1-C3-w9dE*B9SeHS{0i=Cj%sXBce`*#Fsz1bZ~@Uib?KX}iu^(12aS zd_8f6MP$ZuRj_X_O}b9}0{FbE{nEGwTvpzID>C_M9f&?Og;FowNm?r56+=|ndd8fvyv z$YFaLzP0EdU0K(loewv9NS8vNp3y|~%*9iVYN(W};sC|4x2F4lX5KB7{@w{f-e<`j5j(^b4e<9v$Z-^2bv^1nt1JPG)uG;RBWTEn-cl zIFsZULR18SOu$CX*-6FQxE&u*|CBcxn#`p$txY`VjCUw#I;Iu0ZfElU_3m8@&U3b6 zR;Z@M2K^J8YK$Zbh7lZ-xkaYi>=b6bdoU|W@cG1JDUg7K(3y4VYil3Gj8$EUmi>6S z-u4$4F+#my++m^3Go7${UudF3x+7+!e!=R@B-z^v#n&8-!^9(L$Lil?@@a{=S#C_6*ss$w^l!-(I(f#)7T@!Q(jEDtUIwY|lO7@=m`4t$Q^jqx$_pwU<{+TH$uU_dBW2xt(gng;(5;G8$W&N7dnMRDqgm%`*H2vY z&Fw~YFF@p~O?A-pqey@;4lb0~`-)D%zzOqyY5{y&?htO{_mvH4+eW_i$$+|gG%8e^ z9Ug$$T_JHb+Hg{=j8%utw&CVvp{bV{=LC!Vj$K@qbMVBPiwn7cfVRR2;p~|Ndxek# zF!sZ-h_SvFwr0{zWn3dcd*G7`j>H_8_knO}rSQLS4xSATjE=7W?rdS3fOGs%wcUV9 z<=d96)@@)&w_EWiqSe~7bS5Dc&#WbWOS>ZYH>aTm>$7y&K4fLp$8grjZht30ljD-y zaf9A@vNbXhLB5pf;Gs5)vzZaqV#q&1rtEEp?bWt{^vo)H+|8|A4M(v_ACti}zyFiH zuw-3-ttpL00~F^2Ku9dsN(pP?xf!m|N7gXMZR~GH|58vEpwcS&e68Uh1fP7+c$2rg zkh1U8c)-+Bray8%iF=|dKsFl2Kn}D}6SpWFg#%{HLtYrwHQK;J+kOI%Xb zx0BCTecS{CgJaZdDGQIuR-5Hr?$SJCr4Z-qxb~@VwvU=iGfrI=A3|F#Q{6Lt_;AWB zOLg3JVc3K2Jaj7;JCX}q?lLaN+DUw@>6B6q`=7y!7rI)85I%No~AEH zf}ShMN4K!;i9gXVjIyaZx@Kd`Nj<);49CX4J{4k6n?r>*JpDZ zfs)@*Zpbzv5f$GO63RkRCRB?X71>_nqWfF=J;k@28e!xZTpTNf*tenAN0SU^k`OWy zNh{Nbs46NTi-%WeO4=avW}SK>q1vj?~JN4?vdHn^dOB1JEWCI!aG`Wl7? zPtI>50%TzPWHiw&i{$UxT?(@7cMX-Up(9CXU;SlEWyJjb+;i>fURd$X`-0XcYRG^= zf!+MIgR8OPPbMUfpK`tvQyD287!=W~w@*zR$WLEv_RXs^Rzwqo_E$m(6+2Dm)lm!~aOsV5Pl3Js-Kg(}l4x_F z_vbF22ncYQYI~r;-p{cM<0r%j7#*q9F52a!9$PXd{AkW?y5ikL)OphFkK^gy{$5-b z^U#(KHGQWD)YYi@-F1eS+}Br{sldBqMT5bkSMc(v>sD@JD+872J%2#^%QR_pJS>D% z<&sQ80kRcnLC7c0QzDLeb>ouZSf!dqF`X2P*Kv1S5V7)ksB-Z8G#ylyXq_zrV;u`_ zUT}Oxt?aiuMzUA&WMzqn>}XQRA?N8cHl{hGXND)BeKgw;?EV_7RJ-xb%&S+rBXBe)VTf& zH``adMvwSon;mb&vuXx6f|d?WpZf>qLQb9uWz0n0+DbO+Ad?Kd#MmW`-pzt&mC0p{oxDG>PO6QxHSjh1!M<&tWa@ z$&8cj;ZL;k*CHjqH@os~liq^F1k7WVI{ba?$yiS^Q%zrUB zvE^67BkBq@lSy}v@tK_2br0YH+$4YoAlkc5_Ym>rFPxySjDDrRSB)}#9Wyi6d?mBiQZa*qR_$wpbNsNTVfXzl zpRe>q zmG@b$GO)6Pu?QUVk6h5HkMrd2f~rY;kw#GlBGiaPiXecT^Fp_E3`A{tY|PAW)!~O1 zANV2lio@=EyEIk2L~JwZp;QU9yAd%i>!f}sze+#^o{f%mN;KJO(HRag<&lS!G$?S% zIM|WAEG8j-%w#~gn(8rQ8#!cu7~)^Ht1UKTY#8m>j4{F%oaI*JSI+GB@-_d#JUF}u0{j6c(?9F;z z0mkQ*XCJM^i1=x>?Op$d|QJDZml#^MBP8Iogow0q%QJL`Z2@P z9n14ObIv9V6RbW@8mA zi@5o7$u5B!)B1R@p?o(_9Tx4_%(XB6Mobd(J+CZ9OL#`dbOv=O#pGkSF8X}R(X)8c zrN}ws*x?<#NIcNpNlRjYP_@W9q;#i)gVP%2Ji>}w8ZZT+f^jI;U1|3%_nj>%YwIIl z)}6O)_O$VnTE~D033=_NtTZX|x`zlp{cAo?b8toT1FENZ+$IyUKuF+r>gS)&zeRlJ z!L%#&WJl(-fY6z~Q*{lY7CPmLq;1}sv8+b- z9Ws5L6NQL3`Y*S2Ezp!duH)X!W=)78o?<9~qg2t9Z^>;`lp1BX2UgKWzES^y( zuQRR&^4PhB*A^U3AFAKRH{=9(Zo-XE^^4ux*L1K$=@vIUD^wn5X;j0eL`UqlTtl!? zNmc}BTvu2N(f(lZo##ER^^M5JOb4G?eBL?l5KKY-I=6d*|9)}zi~Ma8%F@Z}`VP8^ z%wdi#YdJrgp6b3oe_$;_sr=y5vMUpos|V9Th^C?tX}| zu?VV5QM1g&V}Bgn(S5ZGX3az=7+Wj)U1Q4RMdONrOIUdik(04Y?ig?71>@ zt}=>|`TN5$d5On;2}%@}gt++tTGj60INjy=bLqlLY}<$wtDm!{_pun8mHD)po_e>f`Z4H2RwKXeTj2M|omFcEP>Zw%sPwNM$GtnYBgE!Yh?iFs-ISG@SA$&4`)HlEl*9r8A|`|B*6d`HK* z*Z_v8dM9J5@vBhrOWFoGMxi9#-_`Ha*4Hbccc1sVq9ZAaOGJk-UMqG4u;<;lfIH<<;33l-l8GSZaSRy_*!}X+LiMF-}!eO*O{b6>otlU#$p5W?FCOukmU@>npO3d=vJ5A_c>Yh*W>v99s%p>U@@s)4Ivarr&ct5TAl+uq&R8 zT9#6>maT?6hw{>}T-f!cD@r04$H*~7rg|*j2ePnjG zn-=Dq>C`exJT7pJn}lRf^{qyOT(~Naq3an&rph%*!P#>XqXtTrwTHjt$QK8s)-3n! z?gkm2(z=%KGWW(aH7D-yAteUfyW?;CGBV;&_8FKv@BMW|q3**@gBd9=8MvU!ibY$OkG7?;{d_gbLk7ZP)i7yS zI$6`=Lbd1Ow;ci@dKihQdYPObNaWXHqR+L<*!1!z7M&f3|H#bDg<$uq)&*q&(!+&f zNv&_a6OGJU2A_0$tDX?e`3rL1XcXW3IQfm{_1+%++2*GYv+j5gZ@~+_?!o0J%-2d) zMYliHde=su4K213X&m8NQZ0ef!leBKyNph&K)>Op`>Jm=yZ7+Mqh*q*(govAok`h& zI<^%FVE9)Jk^bn33)^|-^ceYGbyl>q?yGU7X7rB=yPtam34ZZpKZZleqfcadXR1}4 zoYn=-JCMZ}74JBVULq^O-0a~IqCeKF?+%)EWlq@NZu!6<_Bc|5-r@JfP`x&zks2m> zMdv$bc*O^Y(b*qAgS&mKwU&iZR%xYQY^oTfewRNB&}{eBy(T9Q>54ejUhr89&LQ3i zpDtBfB>oi-rua+J_h^KtJ$uDhdUcbs%ub!jmU1TPHuRV6NB4{HgyoIl4NVf60dP~K zh2m7CIxepig48; zsK^8%BVW0Nr)s zFjBcN?;4wnLG8@QXFMBrp9Mg^8wB%w67%8@Xb|u=+5|m$ViZrRe4p9^8f%2$Y2NS8 z_CFTNW%|o8-EOV9=*TF*(YL~ee#N5)?#$_ufwEf?R`IcOc{BLDV;BV638A!DBeg>) zpmIIt-iwLlVwx9;uP-n6`r zRp`la=7%wSBDnJFdYf_2kmnF*Yzs(X=ZsLd-b$JzmF5@QdG&Bs;w$TlVjefH)%=4l zMZ1D0^w!?;gaTc`x|4~3)3{4@khWaFgnwbvwv$cO#Mcae9z2(MP$qsd#Q6RFePkLJ z;K0NS2->9#r3h_}y&YknP#0e6Gb>u-(Y>AHj4~Z~d!~-g{=Ih3+VfVrp&q_#|8Y^- zC3nA422DqTVg=Qtg!#U5`A;Dn`d;}3tn~Tzch`$7e+1^-i`}o!`j1&HoSUw$jR^06 z+tg|@2ITdErga&tdZIPF5~Gn*B^IvO&t$LsF!3M1Z`Rkh`-i(w4D!&#f+&A@*Re^& z$&K`Zow3)s&(UsfSq1}ytJXOd>%t$bZ?j0AXe6MYJL&`P*lzYbHven(N^9?&GimDT zNe}}{N{3-zF6ZjjU-68HhVX5sr&5H;8`%ERrQqYQ*#(!rJ8JU7xZ)Su9*de9)5Ept zE#M?8z9P7Rv`5p|Op;I0juNbF*`-STD_4Dp>|Cb;VU_9d$g(YK7%;6Il>9sgfq^(} z`qHfopqW7A|{$lM4W}2fBKg_U)6Tj`;Xr6GeI6F-k{_l z!l?@D1-D13wOFIwEDm~)CXfjmMsZ56OtA9p6+rJsXHEMWWHxyP-| z0P*&_-`{)hR==0Iv&2*u&(xc{mbky`8^Sn_if*MsalrSqAcj;w=$=4tDFJC#d-j^> z;d=d7X)4qY~=UbA-bN$C%g zZ>sgCI~%W_(QX*H|HP#6qGNSEV;HXlTot3tWG=E@VrNL3P!kn3%km>t1O*-Als1j> zE>jSZHSx|#Y!fzxnmsZ{x_VX)i)<2+j0+9vPV=zgIe!iOGIn^^*fK9D83&mWvp$b@hXnKuH`;4`oigI;Bv)V>o#=UWbIyGu;URn zuTwY3u`RtMgQ;r7k&bCX(V-KwRHzt~+!D5oolIg}U>G}8RrT@s-KD*}8PAO*WV77R zd-x&M z$qej7c;SkBkas>3=(WXcyNst_**Z=(z8I(yxS?0Um2338CCfVq+#ik=w3~(+`_aa} zOi8in3pH?f#;x89z9%&tb2^=Sy!r#|9o;@z1bA>QoFAxXv%>v%fzEY-GcGFB6>>?bIZo9ZF+j(aoVZJwm3Z3J3e{haRc}?!oZ5) z&qZI#tG5j(Ek4=58B^~sRf*_^OtcFz>pPVcGY3${WUlV@B2`|}Qyg zzVJe){d8IJJEsi6Ax@ziuxry<0X3}O4`2^_HKMXtj4Ks`A2u!poXkSP4fFg%soM_G z&yOqKtte80Znn`RTq_qqnznB@5YF;BZ|K=ny+xfUGH**(v)1^W+4%o9fKuVqzDDAiHBR9)J7D9Eup5Eo_ z1er@f%|hCpt!k1~kI-wj$pb;JD9hMVpBfa~t&v;C8j6J+WbS`N_f-DHu)!q|XU5*= z5o4&F7L@Fy^gG(oU_9hSS9gOGT=emesMK0zV?fP){5>(otj#u)ymk6?Td3m)+c~hO zPsP*JD50m@cHL3aYe>-FTe<%$c7R%~TM9TDTfwww-0x{pK(tsFHV)p%A3$!kAl~wjKwG5>Fj8d6=uwHt<5SsU@sP6dLA! zORvkVEEMH==M4~!MPl2nnHG>$_hjrAI~TTCSpBcM9yjYB=dH_2K*t*oOK)F%RcDL} zMxDu>huVkx#9?^HWxcX;U2qw$bv~~REn@}&<6}^_TsKxCTb#77%W#o-R4^?SmLPw7 zjM8x+S}44EoHWuuAW@Sj&pcEfiqO9n`)w14EgG&>Mc*WW>;__fZDx)QO#hPcUI*(xbE1y$Jp;1=`A+6w^TWf94Vs(XzhGl-nlNHIO(lPRRomG%8rOCE?ivR zK>BAuo3Ht`H|`W4eBPysIT?M3%D;1ilsX~)8n?en+v*RoAhRRhfn1KlJNrgV62nAF zMk8elUK!uN?KhbQG}4BxE2-@3IuEpmDMMl~Lq;t-_aWTByPu@Z^2SI$l9KSt_jaC~ zVQD%4MTI&KW41zqMt6vfXiJ6lxSK_sMRXXHm8ix6@qqE0&!kR6Ai;bhvE|m6mD=jZ zIa_>1w2x26o}cZVta;3RMg?8^PVf*0ueHUdG_b3Y&>YUTMQ#9Cp^2mpW2664;mtwG zy(FDr75dq|@S-e=)r=nPImxDJ#gz52S};p5u$^Tz9S>yaRWzesfbQGQ#DF%!RPktw3C+E9vOhASnO(9%Qxa`z-Y@P-Q@>n{bK zbx#B@iww#wc0F2b7-q>Q3SZ z8geQCWMltj73bzu`u7vKF>Ts5Ee}(w9;SIDWbK;aC;yf-c-U3{nGZk~^4a9(f3n@F z&)+n-fo%6If;$g1ejI;SIB|rzj|1M7Vl=)Dj5+%T{Z;JNz(lJ)a`k!#QD(e%A z`_ijxV}9}31&~Zq5R-X8rkL=IoY8v+y@sf5$J2W+#vFM=^YwHBe17Xb|JzU8ZD0KlcWKzT?wReWPIQamQlY-rrl#woS(z(rNV5SSe6a zN-4k58f%n{8AonQ^{Xh@^k)qU6r$&j>3{LIQy{kTG`t^xY-yb~; zNnPMYxQpiK>!o>6%Xxlw!4d>Pa~8;M4qB+o7I%gr^|C-s*?Udf-64cb_On7-S1?yn z2A*-syQdqME(~tpKpjSWlhwdzW|nW$b7_t4wPc}>igYUvEz^aj>{Ip^74x1&gvWpK zCpqO=F~v}%WgA^y^ORzH+Jb`<&oMZ*BmMSfX@?E8A+o42LCS3f?R`6^rN3gqE%m8{3&I<=6la~_w#$pxqRWPSRZLb-GHimm;X5q z>C^$~BuSVjUlJ;NFJa}A>FJ}J=vUtrHLtwiUD-y)2m2BoSZ7#TuFRV$GHk9{7T*?} ze68Hmd*1h4YBgDm`9q`#bEd0ATnN#Y@_1L}-q-XzqikmMXH8KoXv_c!h|2h(F=0S3n^qi6B)T>8ZneKpwngUzNcpTovS6v-;W zHk7T2{iTZs!V7}@mP0p%(A_Wd%BIR&S_d*+(@M!suDmD?N`BeER9~9p8>f?Vihf!V zS74xTlZ1*je0Zlo7LN(a^{9SPQ{f4jjF$6GN^}}QiKf@Vjk->cd$LwhPu}wXqAm8_ zv7C=otq}cyODJr&irUlM@1CB8Kt8>M>{t!o((W^RlRHUYT4}l8$zHLUi_z%8ISd8( zdb&scpgmkZm~HSpd{cEgQ$LlX)C%hUdfvTe>E+pGW;Qn$Fe0174Il1aLje_8;dyV6 zy%fQ^8j&;UG9X_JpUoHMNcUy-GbjwocPuEccVxOTN{_*ch~-wGZP)jXf|7S~axs*f z4b}KcGvpYpQ1UchXtWOfIv>;heRQw;QQaMHf`CJf%+J0(0M||DU1ATlw`kFoQ3CZx zunFVAuFw{B&kBe7`SBml$fq}4Dm{2DHp4oE4nf-|po4i3@*J9-B(L8JjMExqaDp*p zk4qTlVI3w+Nf~NuJXqwPQ}FcE zVLK=+GrL&|?Jb`h-@hAputoKD&7#5%`?ZVw!wn@|Ve*4>ra~Vy)C~EJ|J-=h*b<>* zOl%5mA^sjd-=wRMb>`;e*rq~S8-5U7A=B1vF@_Nd-2y0Wk*J_5!cQJFlyJ0b?==;eaIkU_s;2ev`z{U;!(BdL*7FqDXy03oc@?s3Na5SFt zK4hePV2bFhUcChH4ae>kE01D19Nu!SAYPYlNu8fY0t$X{Papg$dmF>g;4t(2v6Zg2 zSi~35^G^(Isj}oVNT@??bVK2N*7+(-{OBxmAlmZa=`;GYq^(5aV5c_?3I5?wD1bY!qqM(zzpe(4@tqw|b2m8UO`^AQ6w0eaoU5xgknY&c!lsqg^iRAD{xVA5^FCG)P1ttW zce@5-w@pviNXJNhZJnp?(e6QS4Vc`M+&aB@d7)ppy=gWwF-9{eA8<)UJx{&fm+XSp zf;oKMxfHi`@hyN9FVSggFGeS45^r^gN$Ek6l^ z8PCJ4)~~0ah1t>HJmj8iO$w?xj7Cq>SsA03FMFT#DG<*YWbOx)o}WD5v{xunM1^3h z0|4=*LBm5SdO=8a8O3eK4{<=T#M5d@mEKQ=dGXbMYJ-;oOJ122Q$tUgPltq2Ghf_J z7q7!(rS?yraNM^^dk0E+!SrL_U5{7yM@%|Z`(RV>CYNCgrk=M2GtSEuqw}CXgArV^ z)W`ag>2ggDRdn~ywGly(zE#$Oa8+InyZdFVoB&M8a?+!nm=7Ygu?Tm7YqFY3{NDfT z!^>yj^mg_E(jT61Pb4X~Ea0YMggxfamNT`WPatR0uewS+1qX3YeNUQC<|6YUzX}LOLY%+{-w`mkKe)j8`Stea~$9Uc0 zuO=K0XgttRcx(e%*Y>)Fn4y0_}w3Es;^9=@}5QDKwjXw$`{R< zL6ZDO(kzmDL(BO4fM9=2)|-Wujqa2lKwNvbaQv!jl%Zb^uC z>yo2D;Ey)toBltK7c1Npg7QD&S5!z!QRf~lA)=NUw>ZJoqq=~+)+pY8d5iljU3NRnt%5zz!SHw z==X~ZxtKM0v);&Q^egy4wihJeOgLczQfGbYnDr-16{R-J0644lx3Es*?g3x4NY7Kg z>EtG_cE+$OJo%7;vEYX-e!JI%#eCT;mT~*bOYwDy?rHTwh$q1?9y0T<5A*)03}pow zE0As%2dV0Fl>35Y_rKSfS{DV|=*VJ(AWNU!E8**yuRdZ~nQg8#^vzG2V7KqaaspJ7 z|BNwF&P3>bD>4H2In=sYjmg4$%d5Lv%4PGjfPwjlRIi8r)x{seGpUe!{l1^Q65H=& z1YEvt+-&vd=rHv)yHsk^8d*_?OOHH$vj26kVK3`THp(-azv_ z`G=3%y;^uoNv&bS&#&rAzn}T-bN@b_0d9Oq)vDUtJ?@w`gDP(d_v zPhIJ|?t*{opuZlcJVw5K{t^I6XMgQH<*OWz^E)Bl$RR&!pI&z4(I+hx<9_Y zQl(7hNtsX-9c3~>=c{6%U9tJc)*iXEA`68_)Arml`#?k1>$y8Kj~y=k-xz<-E}xQG z#S6-v4gG%y@n7?P%zKWiqIR|W>Hn?7fBpE!vw6yB#~($>{k5e3_=mT(H=m92@LERy zV=e#v5C41d-y!zDrT#mn{|BzW%iRCO=|9T&e+uLun)WY+{yzos|1Aa5a%+}oM|Ll? z%uLr*RDbf|@8bN|p8a_AM^4gEet#vi)Cr6Cgg1M7Tt}LXv};F;l+B2J;WmKRXzpPB z`#+HXo4^#OQzbhqq9UZ=>0d^)Vk**t8qH?vXFZZ;L7u!0BNmR~vPX&wkLu2Fs5Jf= zpcEJ}Uh6g7wls*_ygKsO4OMt`2<=cmWMXW})D!qClUe)(5xwdQYHoC@Q}2rQodSKS z^=>{U`_-2I%(svfb}2XKb_wF(WxI2bMyYZ*6R9-{Ly4}v`ztX2UyR~y+wXC?%nvr( z!{j+_bZgOtWoa3@NO`c?LO%p}GI=E+P-Eed_a28?+69C}EHZhzU*T-9@vsVNS5>x^ z?yz{=Z|;FNGi`-Wx--=UghoZunf64P>kUdR$?r3W+L{zDzgZa89-M=?8~xNPGs5)` z+Z{|~^`9pnpU9-e%ve78J?;S@dL`Az0uNpu||};=k$t|GoR`&EoNp z={<||^g5h#GAx%n@ae>74`kE#z_WKb4Y*R@p@Wp&&nAUYu1(|MlD2~a-4F}ZwB_`n zTzS}BK{tR=*l=IoGsLLUyK?uNcHc7|$DCSk#nIB&-L)+LgxJrAFAJ#oBPDDE5mS?; zrkvdGFfh24<(o~^cUeP~(ecYXm{};CIOp0B9NK1n^KE|hIYnOT_tR7%$-+KTT1EU; z)PI*L3Tw{MpaYb?@9cH80oQeQC5%VU(P{Nsj&OsnO*3&ilJXbQc%4I%dYa z&j-|;yxnpHuwQ3%wqvzfw$UF%oRKJs}l{Lz^YtMp|50dc-lnYgO!Ed22+(h}%-Mq%8JhL3>`=L0 zSu4a>7WNUb3Fv30WKjFmPFgbf));BN+#wxt<5@yIjFL8c`Ta;6ImzGaG{wHZK073L z>nVRZDNhDuD*^CU3C&@w;P{Wb`=5<5&^>QxIr^$W-cwO+!l#0<&iTz47HWbmXL`Q! zfVV52Q9WdOMq#i{aF$_6&FJHg6aj_Cq`4_tvta3?o=E#anx&Jno12Wfn&%^4eSVRH zCejCT-MaVri;~~MSMxW^$@cpW3h7-{cTq+W6Zk3w_h&!RrP%{%)bz~I6B6u@HyT(Q!<40xB>9I!a$Zcfyy&#DQi^x{+0KHZC#W9xP_bnCRgXzHW}!7 za_cNJ1{cxQlF4TMxfTK)XRHTJXnPaa`NqD|jm8N?x?S>#ag)oRb7Y!ZD>1WC zVW6yXUk&@;)$QAYlxIn|>W62&^+gZU2AfRu^qkXUE;pDhrHDAYeeh*TRlVw*k+MjV zunF>6k^!|9@@5AraK_#CSs)?ABzUJPoa9e;pp665t)^^GStWo-bH8zLXU7ux>Czyu z>4#Q*P3c8hf@Qdzf7^odntgM9EMw6vUd<;u4?Rw9%@ohI9EH9CAS6JJlO(N@>xw8H z7MY#?B6*L(ZzZyyhi6;UOdXP16hBv!>ERjcX}1{x-!eHx8Ra(3&nL>3NxRmxoJ{Xx^NV`j3F( z-dOt~!({sJb$a?8qMM6*s!hltSww4{(?YRjbt+1h=i7Sw2vjV>G7TwiXovE9Lsz#A zI2tmp+elZGAe)(|Ocqx&&lm+Mx@?@?PR$JHq3^%%-oq;CVtacwz|g!RzcP)Ib7LnI z_IKXb_;m5!5TlkJ4UPrWBShXXp z$dX1<5(z#YxbOlD%{t4_TP%jnrk-m}H#9osU3^)?N$!rMlD0JeEKp(0qdXcVBk0-M z3pPvqu{KVJ4Ft6;W%1W5j|{BGW!#1gtA87cw2+i2!qzywx#X|M>TKhz(mK#*rtR5d zu2IV^m{%5ykht;{yYF(hw@UfpR=$;6ioD95SN?%dXQdnsS^%vNo8;Z}4+;;* z@<`O2wQbRhP0qUBok;hMTlMlV&dWTDaoG=XT1|m|by|Zj-ETguWG8>gMw){{6aCye zRGTVIek-0AQ4AZ`;&p#75*m_pm9WTl^Uz}Tn`N@1!6amBfpusDCGHV1D8-Nayhiod z6Y9I{X5Y+}<%0Qxb1~g*xcxvIc1LH4rNwWSRbV(vq+`-OrTpnj0DEsyVgUQ;@h$HW z-t2xKRq39d2l`j|{M))4ilPU>92i-RmGPF|I@1}ISBMt(!y?r@Bh`dT>PUADPtX)o zy@772ph6#u*3tEf87I-rbR;4Au>AEWoq_Y%s44!m1H6K`r4(G==H(KXH7rk!iVUP(DfG;87U)vEpyuG~t32xElluJcF{omBs?zctF2M)g8T4Tg4T{5gM|C4@YHlr$umFX zak*QBI?jM;lfAlN&ac&1v^KwwtM5X8+}t|5c~&g{NN^93ad0UBU^Zc&(0$&dqw(%c z%)xHEB%KXhC8qcC@Fjqr2H!s-jm3oD(!$Aq1kx}(|`Tz8d6+zgJLby9*F4xgYUEr(ni zElEPUHLE)EpYDt84*g`Px2)mZ$qYVFc8}|>>oC@z?zw410jLwLBo9~^mk7UiB+#nC zu6+g+3R!9@5vARqZRrA^TL7yweYGCuRIm2(m4#rQPhgft_yrR2OWj!qM$~ocoVVn? zEF)g$YuokD7_Eh@u{%{29N?B71T?)qspjpm_cwmv*qv+5^$%slqy48N(LCXne&;>4 zdP8xgc^Rj`;eA>_HCW=sqFiQf~dfCXwf%d7H8WSm;T@w!IonbRlGT zzSFgRjAv|WBcA3_M%9BX@t|u+p6LW`7l+o|S#KTvCO!YCnxfP7V!t^`MTA_?9!Zd* zavjptdV;gW0eSoEE*E-TZapiY%r86VXfwOV)svwA*5Yg_4I&}Ry*oZh0bN{mR_x~D zC%O4`-W0I-RpV0DpM8{>R!VkrK??nf%5#o)w`0_&A3_B?lKsDEzyaBmNIH&TUH060PBXVQW#zD|05 zOD087XW`SRgxjc_)phR_oC{AzPkp&T4yWhtEfKKv z8^vWn-@>l#4?!)d;>M=(=ELIpyHZ6@7K+WgXZ6WqD2ps@!L|e6uYk9+&@}kt>MF2_ zd*9X{(uGuo7X(<6xSSi@=0_KTRn6?4>`-tEsAZa=_@EU#jkud*#wX%4F0 zGSW+4QS;fgs74ZKA*4xy8BqG{TTmRfpW;1D8XDuJ`EAr?RGt)8ey# zt!R0F^IiL9Cpm%axw%t2m9Dy3?bZdizO&A7d4Wt8%cdMlUtkLwkrmnyg~DE2<|%22 zeVi2`cQJ3w7Zuq@@=2eKU1+iQpR#2(tEFHhmO(x~q>1Ul!Y!MTOeMe(c|s7L&N@7T z6O(R25(@ob8yFA!-*J;+ruL6qBA6w6xrxo{+ln35!+F;Q1m`6n!=S1NI}g#DW0kUv zNhLscDbb~i_3**QB<@Fn+Y%A_{;_?bg9U*g@e-~1v)VksMNU5rt;r)W=@)(GT=bI= zql?%6Q#bV=XTX5&Pp650QEZjd8~JN+`4?cRZLfcW%!U?cDSS>p`>lUwt?qMpbS`$5as(zt*{yT0_>sH1qhua%FLM+qAd{)GeGf<5Rg zKa0vw+pAy!+~fTWZ-Yo{ zy$SDZQR=~qn{nn>_?Z)nvQ`bWGv#HffrAQ37Mu_IS;h(iLz4GdAww=3N4oaS7ExIb z92sMxS^wbz@EuW=hUFZg;|?z9rZ|F5C_rd@PASO@`q?0;wGj{Y@0F`q7xA?6c7 zSGWUcRD-7sricdjnP3H@+1ntGZ{2!u^O)$|ah-ymtY8wa_llgmQ{!^JTcokcr|xbJ zUfW*l5h>70;T;J1B;OFLE>&lur>6~K)W>!#>?k)e^%q59Mh+1HhthtFx#Xl z^Fz@(l|?ZZ;(%lCat!snc4_|37hZ33z2v9jH`En-8Yp(Bt?b)#YW{U7#Sxz%cEFI8 z{za0A%5YG7WjOiTZ*O|nVU3Hc05Rg|01(_BHhKTzdV@ZtZiA%SCXW0J+04*ms2QMf zU3$9p$k-+g+U+*dP@C$lW7hPf$MW#rcqv{|KFcnanE;p!T;0D+2^Q&t5#J}x!D&Le z!kc=R&G+U#w>Oxs`>)?L zdG$pv4e{xWzA~=riP=%{qxh)x}8;tp?39XC-^l}<+PFMGG_+Dtmt6qgxooQK=O6t80pjmueSg`s#U zlz9hiv*6Q7aKnMG%T)EM3Ts_Yzwax44Lj*gYaPCd0Ar@Xvmpz|j%>N5!D^5rH6mET zBq*#p!%5gqL#FED)0d<&?S3T<3r%CQl13+61dQR*glwT|uz@Trd-KfxmV(aA^~-;! z4HSQAnc>;!zLOCB-@*KE+V^t%@_k1`0#EKA|A586C070%6@T`{e+Jq9{bN$rze0=( zsvgk({XqHO!1~{d|KY6u|9YvPJ)sId_G~n*e*MCS) zs`BA>+E50_RT@1h;6UE#@cf-Ok!s9MbthJO_nAJN95r>f@7E?!;*4}irw?JxvAdEKDMKq{q1AT^0n zxSp=J?BjhSm6G4vd=yI)!e=JFw6Hr{>07xAB}&NgBCQ9C;;1rQ+dj<|9K=E)%;U1J zef^V5u8cf(?;vF{ORmJ^5MpIYGfIrB+{O&00(PkmFo`9d!QAr>L`u#jBPjGQbD86O zqc}b!IrtYF3(nj`UyU{352vYG|E7DAc}y{)!|hLJCtVW?Hxe0Q-w)tm6$!?D<)#W$ zy)JEw(n%OiGDBCEWL{4!UH=TKZDMFA#)ycRJ2;##SA2ftbfX_jaPoTJe4OZ~!@1bQF@v;kx9YeuJy~LiFqh9Mf+d+=%GX@Z z)0G#+X=?n+y}fzksm%u8gx|9Gief8kb&AtWp<&bD6)Ljiro%+t$nw9wgDV;(BK#0| z_t5>RL-)Zp|APxP4SlMpUN%^*9B=pS@k+i!SbmG_fI+xJqL|52(3#Cf3~cFYY0&E> zI<5AW0dDbg(|>w)&%`-ia#2?VUx-NmovT~s5!!=F_tsJ1FpteBaiw<}k;TXRudE9z z>YWAQ`s`T|as?s($MZ$LSk~PM+t8kkLH)RadEg>HrQT|O@N}j3 z8Ko#luHLBlkCf-hRz?QQ=P7yO;>V>dL-keg%TyI#Qt**>fVr$BYdR<6+XS;$7Fl*Y zU7{Ly%Wu@j17!cKJ~RNHH`Ey=1o!YwxKk45zFJIOYx=ol-_5ww++FTu2YI11+FzOr zwN?2--<`B#wa0!gabJ;c-D1!RT4V7MdPeeV0W)5RX=8lwQFqi!^+;yQV=C#w%GU}T z+H*IajcOFJ-XfUAhyRGzi5ze#5RuKx@4Ty6)`q4+{T8%j)$?cc|N7V2nf846=6{;r z?Pk)XPAM~m$0Z50N8RVSuYF7T*^Q4pIo4f^5cl^Q2|TPP6|)dE71#UsX?a4fDnE;Q zabsKi+&SvgO{zzOLqq(ncuWf)_E)v~qlC1+jJ}1R18Jf}l1s?XT%moE@c#Dqsy5M5 zgFPYBrejHWQgkDKf#E@q@QBamaHf}85!)hpN6q+CMrFI0{rv9iUT5#xdV(%@fC>__ z8RKPg;x(t|I&Rk{;~cG(TK~Zt260OgDbVB!+FeZil|udDCp1n0WhiCI67YJIlXA@{ zkJQ%J3wE<#Ezpkc(j%W=&Di>HCK6uJUuvRq+nz-t$^*ZzcoBz;TU$*cp1qw=6>$G&< zsH)STn1DfM9i$aCY%Tp3(v=9VD%2+BzpY{BO;Q;|ZEm^aq?L(YczEhp@^>n+_o z4&J&VaIkw8M~|h*O#l%Woa_mu3PQxa^SM<1OGPJSZsa}vy7Xw0Pdp#6M&mX!huhJ- zuO(Q`sPu7n)a|`#)RfdCdnva$o}bzTuTrL|U+<(}73|-@xVZ$pl=f_VUtLV`x8G4pqO=GfhV^W#X01ygFsk4>vzvsfhf?C~Y)st7p*Rk`T$A2n6F{pl4{i6vXYER~y2>#5)B5}%b0JZp8z;9V!d{3_= z1Xk(mGX3+RLfmrKYWP)Xz|rxX(3tl)&ba2=mt5bz4DL9n`D|2HFa3l=)U?&qPJ?B< z(m>K)|FlbqAPe)=PKh_qk@F(hl(0h9VeuK)x6P{E1x7KY8)swkSU7q9LEYvc9_M2A z#ImjUp0Bcs_ab-yTh*oyOdZi#fl>ysZ_E)3omm z^p5Gs#w9q>xY%~FvkW!#anIjA?0E6W9bNQD_e94iRpNL=0imKo?hjYAn4lq9?bo^L zI4!*7xd(Q1OsdZ&29Dn{b++_Lidi%k*87-FR1RcdGOpkEBfx0c!_qoi> zV?pzWDKp8^pS=O!NgtgNGiymRhsQ`gqN<-y@-UO%Xwh)xf!YwYMiud*i zCE6Jh12TE4kO*D|bRGTE<$q;l!cToyZek^kI5kq`i;yKlq#&>zy5(x_Jt(lzTmnQM zAO^{fFO(5vn95iYHlhG`$mdp{0iZh}b+tR{$CnMuncxQVxpBAg(IXT5WFPlbN(G{k zi_3Alf!uv6vF(m*IfCA~7$!$1u;?FueEwxUT!klYX7R2aCW&>?eYg>RhNCo0(nsh9 z2Ow^fMc)_F2cHsy=4i2g*0Cofq-&*``o!6G!_%?D<~@QA|5r35A*gVl_jYakr=^>6 zvQrLe(Wh+9Q`!YrK}#J-Sq1X01u^VH$`4B0U7PvWdR=Yt{;@Kh#OjUY0+i`VbiC`? zEn8L`hXEo5w-OLcXmucZkU&!Xhbxx=oxB4Qe}>V1@+fKoN7>oPpZyF`la)`5Ex;YJ zBB%ao#DOYH^UYXE2z{Vcirg*-f2s~pfZczeTKDN?%mj$U1D#XZ)X+P4y?v3Qc~=P| z3THp?6Hu>&A0_# zrym4W)h0ZC>AAui6!rdQ%G)4mwE{i8-HK1_0ec`ombIlox<3jNs@{vJOxUyx(4S`6 zO|Y{r%W zS=@J2(a|@ASCRB~t8O)de37(&_$_+Hzz2d%+K4!m-E#HH7ql|@Q1^dN!VG zG@*sf_{xkyO)^KP#Uj`qlMwyuT9#%TQ60F!4%tzuvfNAuPflKv?EF~V5l~SDCs_Ao z3j%+=q|iA!;H{{6rw8-(u6GH~*^;MYCTLEWEZJ5}HJkP@0i>4R{sN}VHC2^zg@bP_ zBBUbI8=l}i=XK74NPqv}ov@jjE*s0W>9Xl>`X|I$5DHA zF&nnz(?H2KKe&N^M_Z@Fw#7q}0eP-e3W5$KSL}aXR+AkY8W8$bWP!4$bg`3IsukNs zk-68n`_;0w-WL~T#NfCxF-;uL>yMqL@A>aH8zXIRpcGx0U{#muHclrF&ym&+&!q!< z&8o!D`=7k`^69e6!pM*D^VQ8b|2oV1*bOIP?0nO2lJK)%tXLp@}er+f3 z*DkiJvPZLFDf5$b35@^jtBQKb!Buwzrh8$~v1p9ebpg#EDPpY1EiOT5HH_sLnKaKU zkl0Btx7|&JeG+4^_Z+wb{VWB+>y3Rdb8mW88Xib#KhVqzZuVtTQXU-Oxg>|*i zcT(bcC+AFfMeLl|a7rOWkJX_p^w{?ng1M6%5)Y4b$C61dgK7&_ak89H*9AviZtD`G zeM09<@Y74EF3xMOFZ}6F<1U|X));-Iw@xYE4Pe4dqpCiZ8pa-W9Lk>cn^~IM9ON)# zKfL)>mWMch$lKPzx83#ODxtd3do%Vu4PDTEv>n@{1;G)_g}9FEB%6*(r%@&bQhce= zOJ})4R8_}G)=8(OQ#sxA$!c_Rg5Z)sSyp3(j(Y!d&9K~73<{l8U?=}{nOsbB3TegT z2Sy2pTY(OV;z_)hz|F+lXDY*#Q&3^8u!nNlA_W=&>s!BMQVjWo_ogJ(`e&AQZ%)-; zBM2F_*j_euvfM(aSjWH*zj=ReAdfzUUE`@OzLf9#*toFXA*R;r$XR=XItIIRV7Wy2 z(bEeEmO3%h-PL!gF?5-J(^r3`;njFfvX--pCOWN)rzmtQ!dN9=*upK>0!DsbR~k8J#GP?^+G zjS~Zzg=S@tkahl0N&^Ow{Vv@$ZAQ_ME(ti%D!lF2&ZUfn&2l3}3|+9vS)xWe=&iGq zbvC!yuq8VJIPc?(^f~F?oY#gjgMk;ZPl%9G8fuC>)^(ltwFqr=YS1uq<5S_k0Llx( zz-0{HE%{Dn!JRGg*h9q}Wngg82<&aGsc$=XIcrVJs!T{#WFtn=Was(brVwR5rfZ!Y z#sj*zG>wTKTILh}G1&!3PwfmUeYZ}Fk1bv8*NM)6X2DgbGbolsBDv(BIGyF(K6Q?9 zA>x*4B()ugtQI4?q8ie~qMR~X#{Pgi!U&uvV5C}p!IBfnzS|`p`&Us0k?pNHrB`Lw z4$^`cKq>PQlFSE6>YC_H>{4_`WE8!nGycoN<9`*>546+B{`{ceTrzo@m~i?<1U2pc zaYYxt+y2z4qas~AS#-YP@Po&}^b67_BhAV+XYAehT;kD6?^Vozmwk|9^ZD#x|4Alm zmIWp{7C#&_sBOg-Y=-jfZEu$a6RxiSJeuj>rjus@;)B)cqU}~xZJHLuJHQmC1QpVfY)KwX^dHizg4JE;c5Q*mlPj9^3gou4ul~s=Axo!; zs=Ybei|iG$tVa!_E?_<9*fFl11)xPm#8+VXkS?&nOW^I)2vD$=>EF-^Vj2 zo1ZaDADlgpmpOHb$q}8zF4}Ja*u~%p!(71|5?j{+#Q0*ojsoZFmIp9xrbZtX%b>lc zm3hrJ$PDg=04GwR2{`lKwSz=f^WSTLwLg{HDAgQENuMe^?o#%BF)S+Bv0|YQdHr$} zP~+8b$g*FYU1)*Y@Tz6DcEl<)+@BEKuH>@%wJ!4pI$auEKcjYQLGIMJDsNhl6?9fG zv-ruqBO8+$dks6~E#GGCk0no>HYl*lSjEd(xNmn{DVYidq&sDbefHXq?AcuHd*ujo zEWj^KjKDX{;w>jvw4`bjEd(ow+|2BN#;Q^IA;$Xp-3Tpc0Z1*BR@#__qf=yNsrHlo zG5)(?(HmmJ$SxQQy73_BqkjwWyN`Lrzz?;B zho;XqNKd0R2Ze?&+FxqC+OK^w=du<2hq_w3@9fd2T2^g$pRcj`L-8RY5Cm8ncAPNM zu}YT>W9EJ0R}9D11nAD?+zyrgK57XhwU3i~8bq!w>d$lgVnx3XG# zMCKQFdtX*)v~9K;AVzN;>|q%XZoCX7%LCt7Le8WN!qgkUFwUC-vat5glfT{wR*-8* zu`xfkL^WC{Vw!XGU9{@QVD@If)WjwmtJRm0a-QNHlFUw?r-=NoPd(@^w13UJ-|^75 zL2=J2Z`3c)6!-K*eD&Yxp1f#0+dOs!|LRPzb6Gx-ikhE9a05OFu}&INBR%uM2!Caw zV!Jyz0e$OxFntI^zA@AS%1gj~E&+DbdT6hA20$g8YOy2A>|YIjTnfJ77vZrp&=I8~ z(M1225Y|i#f}O0!Xs=1buF_f)3TpIWG;R5WSBvXeX0i(UIFr_UayU`Y)Z2BaxY22XIz@BvBj3@4Bysb^>)D+DQAuMyb`;!C=z^yo4Hb=X<>5z8Gn6;2)U=9 zWuUbB%V*5V#gVCvw5XhQO9nIp#1Fd#yS&ubc92d*UD*hkhgFE;x;MTxD2R(3!wTUM|2!U?r>r}WR=9^g6OLt@7D zu!|)2{R#*77M#ckEX%C1@~q{@l_SaA#ET8@cLVW56g%n}bav0-w5;UPtt%M!LX7u_ zA`B@nJ>6ch{!@}Xx0AY*${91#75#4T5@5!{UvJBUEUB8h6!oMvm^Z{%yVqSM_dsI< zrhMQ*EE$v?u>FaDJSB11bmAcm8J5LPvTu3Dxr;lPZmFej4)#XnMHhI;t&I#F0n>MW zO9Hp?=qt??w{{xD#K+1^x1-Zy!i`qr!@Mlqm_$=hQ;f~!KTl!)GF;7q1jP@J@C6dd z3Qs78>apV-lQLuQw{Xmy{aTbDX2wd=9bYiZ#?+`4k#hv|#FS1`(n%A6D%>n=0lTIn zbIsF5fT_GTD=5JboXVW;7?ucA3+Bs)o;3Kq80C&2UcWN{P^8~g_$hpXykb0&0}MpZ z>{b;8V~NO10ABw{zq7HbSikfy3H>iCk`JkuF2b%cW&0(ImBTk(+O_irWMY!iXu;AC zpGOev9zG<#+?D4mwR`KkicMZ`49y8k;=NA=w{P`tI**)l_VRZ(EFfKerti$g0X}R#3X%@7ejp93CcZr*oBZwQN|}gur&Pj(!Ty*>ry8q=0@7? znGA41@1RQxO?3wA^WQo8r2aj_E@*U=)<~buV&(g0(&gkpeOolVPGn#8BG0@ zQPog6ig9whi_q>(&CjUq1}`ddf3iksrrjt|%7>FTAcE4z`{>1NXW@ceOOqE3=s3yX z!9@i67!E44A8$N*V%7adsTIBJnSMV{P-&j&3DZ@c9Mnhn>lZ4c0fdv8AozbHyol8a>FDi5`_VhEu$}Sah z9Glr6Ocpd+963>Z0r=uT8!Il&xgANA8=Rl52o1VDwn^>sw&yX&@FnbG^-4i6P=xXuWrahj1!Z3Ltw!VDOx|*{yb4lP_dEMZ z3#h!#>T;(&s|bPL2CEW1JK`=5m2A@H({q-O<*7&_JR+K|0I`CF~@AL6cTv+jv(Y&fYTE|+Hz ze8&l*Exk`OV;Ox4Tdd;H`+heA=OTS6rQ9H)=?@=y!^J?8FNfvIKnBSZ(Qz#fF;&u6 zF~)eG1@3eQkv62ax{pHl&3d079|#Y|J~9u;$qjcTZnrd6s9x0-Qp$-v;4587@kC}j zkEU=Ol@%$4`5M(>2kY0tZ??o!fR6T)Wf;a4KMdV`P5*dON-#BM4IytN(zJ0xBAR5YU6i4 z{I4gD%x)MJvZM^UM;7YhvLcWE4|hAkFUQfe_K%#}$MgCmRsz`cuZDM;R-OiV>%sHs%zQOIIbL1n`~JD;F9Y zd@XH_zf$;Ho)&$Qb*^5GiOc;EQSD<*DJKXMzAz_xR7jc+- zEBZVp?lZcYvjZPlF(u?xbD(NxAO#o5?5G?&DXItuL>saI!q(mbPF(F_hK1XvIW+3l z`}&~b9p#J^3P5dURh=C`#UZtzh6bl8F&<6U4kCtV)Ak0|uErI8=vh}W6XbgLjmO=)NB$}yl!AI&Z086ZAR z8!8O%sA;gy-@PLJHVn{Nx>UYwdn0|C7EmIeXRC7dQ%62O0dKMt*6BS7@|(3YVP^wh z@%;0o_+#tkpR^Q}a+3>E@~!-uwOnG8ym0&waAJEB$vP}QB=gW{ac^HUg@U>&Q#k81 zG|a`{E<$}vNw3Pyug@3=<*tIu^_S%`ep?_E60Se}uBGYbK;?a)T~B^}MkIZ)=$q!K z6Lbfp*s@3I2bt6hev2GlLRKmH`ZPA!J{JKAF)H%1;v=&tR4ze^Y2aaU&iXXWKOx~K zpJ3vuw&ZU9n{G# zit#@27!-&=NHRm;PAQ#I&$mr7r4y7VmT3VP49}7 zMOT1WL2~h?J*c7umm>cX>@zI^vV>J};AsGIq6$uxprfpdNSOCH9 zgk8CW(wrn`mfFqo-062C@cl81L|UoA=_3(Pb$cc9M%nHAWkPqseNw5Tt(`7i7goL=ARFj@3J z5br5{08}Q|NKDSvu?{EghC12<7wfN4%u5lW+A-omscw8M49J2yt|dF z6$JJ&~Ymu4hn<2oVD<$gJcxUL14z#oL@GFPx4k{+C%|?2ClZF$v5jpF%KXye8MK%-u z4Tv?IXk~+cEnKan@k_P$bf5a6q*_H7G`*r@4Lmen>J-YrJ-d`N2ymQ(Jmw{E>U%7k|yTG z@Dn`&kM$J9rOg$UJfqkv8gYIty>Yk6*3VsH_ zs+kAH7Q9uz*)5Sayw|G(w7K3xYMiJw|#28~{x)_bOxBA@49j;*} zXRJHQ)9EGn?O?xmoTe^8IrIzQr~2j0m-K@!O)`-q!WA|%m1WDsgPO^csWT{{TMfyh zRiP3O&1i@s30sQ88z=!}#A-DYf5x=@E*DRi$Ta}E?QHBRGbPZJVi6&VP)|r;nJwo` zc9{VQ0aqO~Vs;Gkqtl%D=dM=;A!J|Os27Vfz%mSRGB5Uh{;*Nd8Fb^?u-8`bc7swV zn6+WEsu8Z1{igFc5n+28aO+pN^0s9VN4EQ^1gXU%vR=4uXWN(lqD;Nt{yVRrYY_^hs7;q*qoKU@@(DjvgCc-CV?G8mKf?+&H zlBFR|p(Ky>OdG8WVCcoV;PZ94U44^PsiYW6(98Lgc(2LYR{rgw^v_#tJ5{YZbrxsN z!68q1-QcUk8oO+iLsXW5h~$l=*dqYsj_hd; zYSQky`Pa#i+<8bt&ie30pYJP-KP$}`=%;Gw_XA3hra7x}`P#xp7FBIh<1VZ_^!aP( z8MQPiRH!PPBkqKLLHdFL^_qg3Qd?U)6$kWDu&|118~zhaE#hgt+t|a0hWmQc<_l~$ z?2}eIY-fFH*xvt!CJkOd?jj*LWRj=ciqz6*0zLW0%lWg_Nwf{U{4&NC^}5RcK~10F zq^Vv4xg(SfXKi4h&n{@iF%_ZWhvQ*HPwp=2NVyM8Sb>5r%JUI&b2vEbg19Cw>ND2A zYS%sd9KVt|*z9O|cY$U-Cud#$UfI_mShGWgH`+q&L$p}ezC2QnPZxNaeux;s3G;c_(H zTnnJ5XYqhej!F#)8Ua_Xg--cc$&VV0PMcy5*+z5FV?j0A$^Q1g1Gl_0*@=z1j1m72 zdv6^T<<|C(D~ckBh=@odNJuK(h_tlyP$J#Z(h>p^(j7xL4Beqp!q7Ez4>g43P&0gQ z&N=US-lOOD_iw#xJ^!$7Sc`q%d+%#s`-;!?x%Stf^fs3nUT%ju<25`&uy{Rpsg_f( zhSFecSD3!1jDLPMOzTtBd_3gmu+IB0#7Q5PN;5uhJVun=sH8euAQCR zk61Ha1L%S2pM)uTkB*=6%kx?_RY}?37_OQ-qH&GRng@q}Wdu4yL zCWrDV4&@u^$|JvX(WksO-WPjyiF`l?TN{28W@S1D2nlz(Hdf_HPv2FQfcp;x22bLu zD7Crfw%eSvMP7y_|NO*rv$A}TCa==_!5_F@DkQ-~5nyrft>h4;upA-C<9`O%SJKww zg?y$M*7LTE@!&cVVDt7=8h!GN-}nfCWG;KYK)G$=wOj^QblT@4glf;6WMXQ;gIaba z-JA{OcI@6|#ON%JJmYruE)(L1MVze%&H^R1<|e(I!t%W#rML!}@w4%pV(F_{Y#sbt z-Jpq$8=5ybia?*2B#if>=HXH*;Q9li32LFWsZx#wBSgexJdbu6)2*uvz@q+}FM^qw zJXtaF(VK0VtIG=VkZHyk)oCH}T2Phe!E89XjLb8AZ1N-a!ygbCf&inbw}rlO>eR94 z?P=oFSNgY)DJ?z6-0{PgGwz{wm>$_j~oW4Xhx$cW=>U1KQaud0cTe7wvCZE}+mc3;0 zLULR>-jXC_+*WEUi*GSX%p0c9wJ$m3pP6^bXS;jLyH*#Pn(kBvGC!i+uPfGRo?6ao z6V~Py(CUd}p~VTyS*gu!2ECA-#C1(CLMEF-A7%o>6%L?%!KD5 zZH^b}Px&*%TWQ@qDv)ygH%kEb@_agddv}FEF`_Uw{JyofNM91d)2Q5YHisyU<_aDq z^$;?@N01n+=^K~Z-GesYbQyueVe@-M?@*671BD1Tg}FImr&|W-?9bnaB@4pcU9H>Q zoof%9Tcg(SgTDr7;uPK^^{ON zjL6mZ4iq_f-Hv0UNo){D@p=CqRBHLV2}bYw=oq&xvO{m#rWuWGEA2lEk%jS#*ZSeD zkeG@U;`wlcKZSS`q%P7aW1R_(90Go6Y&;K(lxZ}H&<=<0k=URc9XXI8tUo85XJa;^ z?RBGhnn)QdM+(G`V|zT`F(n7Nu&=#4u%GrEd?h<#=IPY))79kUZPR^^`td4A_;YGx zj4riHv0-(1eaDO?<3~EuQM_>)MZw*W=LTK%!ht}JTnIuB_T*aK3fa_`U~%7S^G-<5 zfp=PlpS^M#GhRDK+5(xm$@7sk{iX^l65URV^W@&=#b^`Fc=A#>MHXUvy7~cmT0R@< zN_AVSC_dIJ{kTDEkIsKwV~kMWZD`-mfb(~|+za~|5}yxwFVaxwT8HQwFMI;ivGXB? zm(W86$An*0!g`u({XFy2KK7Fos^^oa#%vCq_G1-w%daA}k&Wskdhgc4=Nx#5i`vT! z&Js&%`}6|Oj=12BOS!XatYb+hxd=9-1XZKrG#EXHso%TprJH6xwc$<~c9aPOy|8QD znh2q@%QH^Z?;DRgnbK_nW|6M zfU)!N+u4Hltme0;2Y@_jjuCZbLvkgBl-Ao^vTk+BYA-8I^z#}cBIV||OBzS_M}5Ux zb<8P9e1%nJ4)?~nAOgFHZFrVb7#CS5;n2*J#BWW2dEt1Vf(UY%r`#Txg72s>1&&PD z1U*(aMAB;qssb)?lZ?J6O_uOQyZ4|*z>b{JhMVSS#UWGHz3_^*WX}FuM?B*#y3qW^ zAZPDlV|Ht$z`kSh!=QKx_DV86JGEcBOm+!)z#pyxCCM7pqOv0!O8v^KE$Daq zJZMjoaMH7rr6QozNHhU;NnWri2f3j`wBx#c`SJ!^5jf*;w1aUXz+c zCE?PUYzTg6^6KT1rLFrpAfN6LbJ{AQ1GLovsv!|kv?0lhj9!yQ*A91kG+j*7K`GlQTt-O*{QUzBh@e}NZlWCmAsN7)+>|;w^xGjh$d6--e$?T za;%)LB{35{x$x0ak!>J02vpPZw$=2)Y9m5ndfuYxmQ&dkvhK$OHu=@lT@}jY zXgb9(i#!W8wOR!h$bfxEXwcmURu|^tC3#^vHC|Q~q7pTaI!P47Dp0n-P90oj7*+`Y zGIy4t<)~)UVOlfu#Dc0PHat&Ew4oQ+%{p#%|%de;44^;(6K=_GiYy{SV!F##W9HOAuCFzmXh}X_62r z{F2g)Lb{TAJtVFrBIy$k8Cy|LcW{I0Q$^HSsm_t8q-Wtn9x*&WVQTg$ef8|wvPDIR zS4Xd`CjdIF%)}B=Jc_UE7fjzM8-HaI@Jpnag)!3mK-VLyg&X#zDOOy1#<~0 zpPJEUjA4r(6)HjIogoJi)qT8hwZMgOZ2vOctXd;yD;Vxb|XXy%mH4=l_tVN zKCC@=*R{L1xwP%aA*Sr^Z115V2v5i>6pKaTZvadFLa2_-kMdwC;L|&qmT@)rD1z*KB1f?!GY><9}@s=BhV5 zpY{q9=k@8naTYU1bcvM7uraWQt_Ti@Fy1OO8D=?MPG^8Mt{bk#RJRZaf6M=;drpPC z|8lTL2o}ZRb5&}FuY?G9l6-49Rc9bay(1T}^Yqd2HF9*$IPO}NEy2i?xG9yI<#k-* z#O$wek)=5;?fD!FZG9RZuuPse4#p{Y)Om6IYEwiMXl+(LZ=~Z zEu{@xf&=ySMCIoLwzBcv3xR2efkGS1mHfRljeck75rdV@`#J*>rsyKAW(#pH)!yO7 zfbonLezKP7-X+PuC$=#x{ zdcsk?fvzb@BA)loTQ8)HgJ>FiMBYVuVisPqq;@EyUT#m6t9Wr$3Zeyfi9}G|EcY?V z4=p_b8#3V`lX^R84YIFx1f^wGJ$!}#+@p1_)Av^YMj`J%XR8md$On{B-rLhM zIRXoBY|zp3MA#e4b_wC9CffM!MIQm#{QWL4Y4hSI{$hxD`8&GsiZ{qQPzFatXCEhy zOMi-xhHx^kR@_BRZ|#raf;njHGg`vXF?Gah*vKZY0FL6P;(rug`rHJ*;=#3dJXbSq zPW{L)KVR=)+QYH3(Q9h)IX0FfEhnV{iN$F%;cfQ%>t zDj?yTP-yorOuT;#;xi)!u;U_iRr<01A&q~%VZ{QFgZi_5d;32E)qg6pzaOcPK>baR zCoG2JkCs)x7GTyV0p*jWElnw8e?Yqbr)=`CK_<@ccyOA$YL}rhlUVo*hx(7r2Zp1{ zyLy4ShX2_w|NPhIwbOn~CnUlX_{T#2{TcQoz`CS3OXTDI+xtJh)B)yZw^v5+ZxjFT ztN+QH^4|sjubBO#-1onS>lbBsbzc6fQvM+$e}>!stHb}kF#n@d|8L%0mwZ0f-nQ|5 z-qr-V=t@s1(5Azn&u!^6KfD->(}NGtDx-#Q6W{deaJ>%-q`zOQKJPIQ+*Wb&lD$1W zN`pb5j^KwsdZ_K4=KjBJ3?u)qh1I0Sh#GHpd+FSf)jo%a7)CvYk*;0nZECY^s0P>} z@OPQ}N*_TUr{!hPs8KeG{XoWsRFsKNA^Ts96e=PDC4DU>*u^P0#bDz>;DQR1-wJ*e zJ67n*ziiryFvjI4r?{M;*f`qA3w9Vb=wS7dvC=DzJ|vDg_6pOQD&X?^R1Eq$Cpb{1 zI*UoRx=>0&$qgPBSz$F998_n-{W^w$6{uy?6CXAg>5sAlD+C8Iy{RhGae+(V+m&dK~z99H1PvDxI6HCL7eSDc}4kI**KH{3FRGzV}W!aDaR5d~sb7bz*1I?r1%T<-Wz-VRq0VlX~eRYXTgiOS)Fnaii5-g+xyb<1<30n0Oi{wFrVQBI-an z@nw+V#9!va-&UN@7Hyfw7-eEw-}|A=Ps0c_tKO&NYO`nYdd_MAjF3voI2JWtv92w| zXNT1EobO}PyPnL^ElDKEDQ@9{7DwKq)UDciFTDmmR6zG;HDZZ^pr%rKQ7n5Gl}hc5 z>$)zZC>;{SNvgZkBGD7eLLT~MBJIV2DS*c25xma&F0e9VsVg?#F=E*Q=J-ycC22pk zN%&n1r3OU7y8dFx0cEYLtZcmA7Wq!TqwQYoms;KUs{9JibLaXZ2XH<=h2w(H{=&y| z&s==W2zSGvvg|nu7d+S|C9Hd_7#; z&H7~XD%rdSo0f^Zu<&zpT8YBx-^Wwh`*{_Qt!-0hBm*hf)GuOpgGKZwY?gjAiAk}T zwc_mLUlvunj?mTryx@R$ZHzR5^t|9)!;QON@51U{)tj}&-ZibjBabM$SppQ$Yuv(f ze+3kGGZ)Be9_7=ljFUnRhjV2Ir|Qfr0RTEx)y1mhb3R0eXR!5!ss6;)GAqu?0Gkm1yiY!1{DWW3 zcO!D2P;8LwBetlG5$}j6erMh93^R;x_yUKn8mdEUCXaGXYP#rb#BawYVthJQr1rw@ zvS$mt1_gk%l3Tm8C0P%dK;oTAPki|~dvQbJFIbs0c0V(LvddJ3E25IcU&mv(uy|a% z_VU^l=^Z2fi{70|nP_;bau&_-1TG=Vt>XS7{~5l={8$1^{h z-EHi%af4nLqm0ji#+};%Fbs>B0h&e?iBhBpg(**t(*d3RRh6*w#Ou~?;XM_EOl{7t zcBwY4a|fvp<({v9Tf~nuW-QflUgS&jrcYLvhzg`|R~RqVx6KllNGf6#n4kVaZzl9t zr6}62!G5GVp4cbHUR);=_h@&lTo#8X`n zIlRua(%crg*0A<2Qpi;*LE{b97K>3Ynfmd=Wp1A_EIn2T#;S1# z)JEYc`G{F(E823TqM%Bky1uo9sg<;A7o42o$*uZgT>fZtye1hR3J5NO=i<1j=Rd8_rT$v&A>qB*uVh3zl(ooslCIE*Iz15}c zIj!E8ZH-Xz)pDIC#;+147Eu;{EHpPDg^F=%Sia@0t%2qi6B$dgUF-L5J`uwvlw(Mc zH2Qk$SFbob?4=}TiDIV*b1aiaWN@HH6raez{yZ&y)v&Y7l1U7pOkjP_%OSa5Yv8hA zp|w<}B>KDXZig~T@YZW3tk*^vgmREJ=v0*j$)djyP@4~p@S3G2%k#D|A@gt_?eeM~ z9r6J0xJYI1xg^En(}+ZkSswEi3FLW_+O8WWoTv=+HXu(p*ct<6C5uz2?{SifD(AH& zZm&RCwBcEb$GxSRMQ20ys4=43cwzR#Xnk!nb4zV5g+x~(bJ_xrlG+IfL6K`5OL}?Hcad{|HUb@#_6v+{$@*qwl$tQxpVlDXluUPgu0#^DX>?`8K%Gre6I^zUns{ zNoEdeGi&zf8;%=X48F~M#UAw)Y0DQ4U1L%EogyT^v`qrKG`Ry&j!P8R4{2Qc*z_EF ziid&U->(0Jj7(Jp@sWas=xBW7KypW$tx}^yf&s?}Rtw_eGb}?sZsTxx!acDjpd{4# z#s1*|1RBm^dOmGhW&NxqiRZXBS{EqhH0W}A{>W0^SwJ3dnv!h?+CASxy4$o%{|qR& zb$p=!=UP{iCFeKyBRtruVI{aDX9H?X>*brQY9Je}4G}RkEE6PrdI0aENe+9?gIIG_ zZs}LWI-mba(L%MlT7&>(nbR{NHmq|D!re|KvnXHSOSe|vw4o!ZQk_e_PD1MMIJ`Ja--S`^e*V!yQu ze1zPvauGXsL4Jzv0()th3?#1Yiqv{e%iSUC4iaIUT7Td9J@DZ^RMy$}f9l2QMJjcf z%!js&Y|s6|yP))7g+t^gK3+U*xy16peVm~32LN@jT@dALw(^aQ_v!-P0(DW!qO#!{ zOl2DLWX}MD5!ZyMyrdrmsmu18r=xbR_=Uaq8itkv5SoMH=T(2yd1j{dijhtZ`~q6p z`I(ks#$y)#f~6Xm6lQ7&AnQha<=^)7)SP!_HgK&+a&UL<`ibI{ihmF8qp6dV92_?M zQmm@H(*#diShTCXoT-y(I3#-C`k?89Z|G*7aM}PR$v}GUcm13x{tUi`Z#FM;s`iFA*ubt|VSP$`4o%+fSH( z4a8BA0>MXPnk~+Uu>j;EKK#u4Y_)NNeKV_kf8clE*klYKw3EpG6=9kMcu?0Wk8QTgT4L4QoZ5#r2F z)aMz;BM`Bj86`91CHi8{Dq`wU4RNbJ_d_<2s+&_I)TUD>7brtW+?gmB^Ws$ZrxAHf zU?7nXdtI`I^{aCbfw~exuqz|&Dv79U>U$9Y;REh4fI}rt3MvEu@KXor7qi+iQIGj^ zfyurg;|kyL#;ndC{xbR!WXWb?foNRP_pNIwp5??}xKA?ZY3|jpeId>E-8&+@3k{`J z1rSw|;>dN6yclL>=GTM68DX-|(Y|gfnT- zMvp2IJY4m~P;tfq)ikLU!K8Pu2H#0b5OI^MdFJhKAY-AIw5#IXfYrZ zTy!YmLEfJhCt>fM+CJ(bWxn}h&M=JszOO*C!uZAt=c7o=n=Iu0E&!t*LZut$U@EdFlc;&K-|yXJd^pOMvQro-du3_IUCZs3a&`48W+ele6t{d2O=J zwbDBUgjg?oDUhw`a&f-fs{B0$ks!poGFWW_s&r1JU#e@PaC+3PVA9!!3eC}IO8?%A z@(k>hec&+vbuLv1@j^aA3#^Aodw44yedH z0|C1PF6VobYCf~xW3OZ(Lcb}@ig+MueY~$wT?N!$KMP7Hj07=|>*v*s7AmU&{4N`( zY;W+}2%Wx^sEL)Ba&XjH{vC=a^0p)7I>cIK@5?VZEfw0|%g8%^t2dR-3OH&y1h7!@&kdH0IIP}R z#gC);&O^BYpW(AJha)lBg92aK0allQ-0fipCI7m${=&x(t45!Bf5R9`;aq-0D=Q6n zo|0Or8+T*-lG7f7Y9t?VKXTcm0Xz^v%Z!}!zj&XdHBb>hh`l9&md8?I-0JSps3s?P zLekhu0*REnQwj%?C=tMaOjcMIf$8+qn%L{~HN2Avf3uZ@foo;5i=Uhp4luQl+u(Vx z!tdJEBjPOKL9Yp4h090|x-D-b;ZR8HQMkspoM>X!$B$Ga+yHV88fPIh69K`K1;6IH zyfklllimxyciv55SCm)?NW%}xo;cvLt^7HBu^rK&X?(PPo?fimIydiW5t3^UN?t|R zG_wD}m!hG9$_FSGdOXQ(_iOwxqQMMC5}%r6*#re%4`R!Z;KTWw@Z#36L2gP)j&H6z zek^BzMw`Npf__X`8Ho>00ol}zF>lS7Ys9@Hvo^4X`YQ9W(Xe;_%*p|dYsF_kAh>-L zR9;+hWYB>_!3+Q)2>2ld%#C5|qquJzwz!MS2I=D4Ccsw7?(W9@UcsUMPGF_~+)YX| zNY`tq{td*&nyq<9!)FU&>xCsW7iKk@o|fXhvw`1+NpJ_`)^ty3Ytl9$IrhrqZg6a% zrDjWh3uIJ>P2Xm>7T6$X=!{>-SIJPv0ZnD-#3)@Esr#{I0R2U+{FVkN>|xQa>1jqH z!|NzmlDMNd6m7}#`%3#lu|RI^7XVvWMi&^jkLj@%P_RAl=K0XifdxCOUueWXzH|f5 zb55Y4Gdv1$lLfQZql1wcAd*NFa`E!l%s6*^tY5Mz1ts1FNuI)nQ8rlEAZrkJtaIK@ zxg4l&B8Uf1Dwv0Vrc5cr*M=J(p(uP_c){uZg>vnlKvg6VfQTq3XoMVtBUyD?2CXVL6do!=d%Y9m!hr0|4*y5)l);s?uoLoke`&mP2k zTqdUAyJ^wh4_>GjQaJg~xGl%d&AoLsxCd*yIrszxR6Pi~X1)f#Y;(Eyo^9ysCV^M< zOeaPcPYpYe^7++qpt4lsn^gd6f4(^1zh3`l(4K7_aMFm^rbz{#$fB4CnIqH^DM63@j2-hgTV*hG;8qMtxr{S4Q#pe_ng09ZbB-fk7$CL{lXV^v3)<#PZkU%hIO+ zd$h^qA*|+dWd?h7fCh-VohbIqY2!!?PH98Pj{fB}RMt0ZP|dpPrKcR$r^ZjShH39b z3f`tnh!i_Mt-=DGdk|dv{oAf#yk2N68~)DEb|Nis8 z7~KC|u>VB!|Nj&csxB;0Qmb%H{r#7mq;oH|R}&b5#B~QW0ZUCUDa8(_inFKQ%>mEO3j0 z?4pQ&)qH;_te5HliF1#|_mzKVagI<2tPS%H8IxZR@1Hq1t*Z{dMR%e_{(Wo^;Dh84 z(kK4=0XO0T=3Y!EhyM4m%>jr(ta^&kt>0BEFtPtm`q#)lpfUfu)4yH9|98b32pUz} zK}FbCW)qcrclav<9NNzoYv37YH?C)(=i!vKY{haZ)vxH} z^eOBL^Tt`&aKl-N@oOR0D~_x}dZ~|`WNgeFs$y8;*cgQqgJ5)MMu&Jbe&k^a0aMS5 z*kFnF^550V`#S&~q-FPJ-*63#7kSZiq&nI$2;=AOCuIA1 zi6(WjsF?Q}vLiXzsyk)38Z8b=)u=6IcBz5j|MeXP+sM>&g~&oUj_Kx`+2a+}#GfkJ zWs^f#gBmsYDFqk2zhR+(!hOKq@knjE=`%xR=E-kZKZ6G75|gU&*ytd0v%J*(HY<*c zo#Pyh@qDSWn&%ROJv-{JTz^$5SFKR3spRheDDhQ4eSm2sHxQTM@6hm`0JLEh)Vrbc zeTofmH8}4E|9Yx?uz>gD^HzA#$N_l7sgBeqfqdQ!CV#x>%**f3!j}KsM=zQjifeG8M+Ss39V(lhNs&dIWQzS<S1R?RV+ z>*)a|yYm#gR=q)pRI%GBwf#(F$I6*X(d+V8d#2Pns4jKa1L!CAv-5f5y+Zl9y=umX zu??{yP^Xfjo+qbxQO`xGfNTtPZvv%PJYMUm{3_d}%DDB+D!d3tl)O_mclmBGT&$kR zpu9BDijK6TKr?O@&bvu+@zuL+1bravw()uwTs(i`B7PAIbhzX;S^f6G;On$VH(qOT zY;|(YY46No&p<$)4WDxG!x^q=Bf&+J)up5T?|H31cn)9yp~YIz(r_6_roO_}xZC}G z)in}nMP3ZM}T9>(#8;l3ELjD+TCMwL9Km=Ilgvz_$Vjb7~R| zp2rEZ~ufH(51W}ps5e2IKYAQ%4eHErR zlfQII)!ARj#(F7l5fhn4M9#E!_oSCdi26YSE+IEX)7eeF0#LyMtL-_0uLwRRm4*2< zS<_U@V{?@t2XzBH#o$dWJD9}pQay8gsH*Sy6A!C6U;5{Q+EJ!S65?zhkKJN3Dri(H zj^!zh08ccE99mgR&lZ&ikq?*7BLyP`)LxTC@i5MX)w!NLOysrvL`vwOi!v|B&w3K~ zeq?{b-u~Od=NAWq4xT4dXPIk@0c97Z)@l;_YkW!+XK!ngN43F&NY!U*MzDI6jeqZS zS_-v8*!@_ByWA<$j}4fZ^MfYfIlJ(K#Luo~?j-N_v4cYl)-uFia6mi89g6Vd-CAGh z&hcQVWWHY-$}w6XbjmUNW_FziXtSHBhnz6dpTK2un5d@zaa+a9Fs|)6Z~L!y#~&!6 zTZ$+~S~w*K*=C?Vtn*V2bvwO~_Nlrgw_Sp?39=qq*hx(*$9adKO8DfMXX9cCxwCi& zHec8Hc~r0|A8a!gP%>OR{n&fD^lroc2lK}1{nsUCAmn3G+Lc*Pb@_qdP6`6cLESS3}lzSB)Ia3t89||3NwZ%@e6i_YHy6`m^ z8|blQ#cUkB8Zr?bnts%^+6q5x0n;^oNh-&V8BZE|G`iPIVs9MM;~f1@ z6-YxH>BW4C0?Bv|mei9OU5E(@jc<924ExF;TWybTqsUJa`I$BzR;5@GlsdPj*QCtn zM}b-8u=ZVUso&Dk(@-dKNm#EIupL~hczfFUGPph2*4cuQi*bio;WVw>A7R40^xgL! zUUeI}-}%_El`3r2%TcnwP2`8x9s40&;5wt*O)v-`#-&$feKIiP_Qsz}pWSyHl`BX- zo-he0do6piUwiD#Klzvr*Ria=Ft_!T+ut4{*W61GJ@rj40# zS750>jG;kUtSbTFkuIsz+D*H~^5F_+K6A(UE-z5y{zMqAc%T6tK^$b7S{psbs?z)O zhZl{BI9Vpf^hl>|9Bv?ShMWW^?w&tsb+LuTg|9V-x}vRD`STdp03Yo(1Fii5Z`IiDp6yUZ$=^2x0w9&d7814eFe?zKQKL zMRE6Ah7l=H*A)_0cArcyr>ovqomq5Y+g&j-3y+BmI07N#&`)C2D0xg4ufvbehvYGF z30+4&H}EIjknKiEvv!716S0Y~UvEBBj=2wksSR`;JF`A>@0l06y(#yyhO zehxXTG@e@KNc;E+$?~T%yd*EDe^A8^m5}I!(Mj?{VQwD7MX_WS{@kRamoP09o%kKF zoBqUNViI>``q6lNh@ieMw|-+2^e#bq z-<0$73!5)0dw*KSwsMXc+0r`dD~HKM8p=(d#2Oj?Tpl8Z8_uBegCgmWogBzPzVUpK z4scg>4b8K~DoEbMF=w~ z&dt6g>!3|jMr!kQ$3sXD`xWwA?5dmkuZzwgV^uF)oQry4NS$8bK7SD3LzWOc_ zabjG>m}XvJP=0_Z8EOFP>wzb`Nuic0&Li7o~%KGsUi5$Q*-4Ee#O&9aqEiB<51(>3!1|=Q{UsAS-~M+Dwc8_e|fT zt7S1V5q2|S$ojzcvpnGTtw7QS;y^eMf#1~BArH-akk$f!YW~5o>McH-Eul{5kqry~ zO;(O4SGzAzFsAZ6f8_WW&x0g1PTW_$_<}R*gThP}b}+u3SaPAgY@==)joL-i&QQ0E z);DwKp7R!m@W@IM)u10ja)ZH66rbzbD?ZwLI@f2w6i6UikW4FG(VF% zAJ8-V-@zzNC*(F_Vg`S(+ho>Fjl11;fB6~;a~VsBdA+R6u31|q&F>!8bn0^(TY@S{ zk7{YRW?`X4*AChD5(il;Hp?gT0f6nDL`>@)x7IaKt9&PZ6H-)3j5aN)9)4!l@t|oG znQ%shbL+@b?Yu_$o0%Q`9W2Y%(sU<_0lSJ(-b5Ea_BZMVi#7ClJ^tYPRo^G>|8m1z z!zc&h9or_+#G*{&5$%DcMQnXQk5TPz2}-7BCbLhc?+P8n?fB|V%z29H5T-o&>jF%* zcZf=6p5`49+wzFT*MjwQORaTj9rZJRG|LaZ!I$WG$djMH)_;Fv2S;0^+~Qe*a=G+q zX}#>_Pm`bL7RQCz%r$8oV%HQWgl;}h^^H>yA6%bX*J3u*y5CvB>w!qiebfBC^g!;Z z*(biP*52L**YHG74rU!eqo|8IGu?Jp<|^v0afVQKo@G&@1)7n~kwsFn$E4Ft}CSvD^k-~0GA zC$5j)R_8DzS8unPzE8)!A?(DB2JCb0#9AxQnGE*BO*eeIZY%%T46n=W zg+n0*xFP| z2J(nM8l9hZ>A95bi;5T4ep|U0uYb>sNdkKZU^7g};@{K*T*p>@jUC>sh7{16k}_E8 z+XDY}Jb;G`b(At@zn!HovAttZlaha;p0PsFDsS*z$|MzRnL*q=pkA?NIRfAA z20&!Bs^zBZu}9f@u@B~s6&yr6<@M>v!C^HzS9d$$Fq&(%nkT1t=vUWAaN|t zPcKhlBE$P=#Z2)k2NLxdJtE4r9Ow_%r!;0^Tu!ZsMB5Ag2|~i506nzaU);~}zS>vkX?gmIhnw?%w)P1KSn zrWX+EynLtda%E}>EJT7baL;`HA9o>R!;(_3m)B-qza_Di&hb)0{!0XFXLlWLo7BMP z2lsSvQlB#sSNFI=WI2HLK`3kPJMl%_Roqr0+1V8 ziuy;O%g2i^($R6b?O4yQJw75mKj%OsDjfsjWd z#M=auMd$)$>lMw)_6bMH=3w~A2ZJSPfOx`?ontx!`##N%HKPT2u4qZqcjmHNx~@%C zCE9bcmECviEp7bs-!?Dx$*qw;KFNwR-gNW=f(JfA?%ecv7Hc6i8;@+*qvq2{J~th~ zsW(uaj#q|TI$`oXsiwC-+q1to5u_^B`wJQdknXesU}M1Yry&-V`R zkL;4#y2?B}=s0FLnEO@EQ*9#v_@N(+Wi9ROby&Nb%`jQPBpz8}Rvj>0=t+3FCU6wG z)|<%ZvLm!Mr%*evoWo%nXPV|Zkm6w4vZmEC-0lBx+*ac|whvF`rRI~aB;m}=VZ->E z7bpp9o1XZMuktqgIB{&7Cw_=YBwk`}K#9Cc+uO5u$M5(KS`>XNY39MxDYXsv3V(rlfJe(EJa7pWsJ*|a!U_@Q^ktxXErLNe2goF+_-OcX*9~zsy+{Vf^%S_!IyaQ!{fyq_Wj_qYa{mZ3 z(d1&>O{!`UZWp;2FV6llk5Fe~xuGzpPcp`^HkN>W98UOXup&`0t@=liM0V8E&F));DB z;HiK*g@Lr1-ldwc0K2oh#bOb>fcn?ei zQ=$JJ{(t`V_tP*w6~M4ZG5v3YKCA<#fkAH?_{)y|@#_ZG{lV8#;nx2)D7FqT4WH;r zvEQeE&ByU3mRU|#SIxf-ipl!&WzpB}$tVA|;{3q;hldQc|7}nVBC2$?g_W)Q|FYu$ zr?#<7_hywkM2{w1i0c&^h18$4%S&DHbx?>+4S6WDk&6&M`8l$WocES(yX6EQ6r0M{ z@pjig=^Nc(UtAs#4A9FvjHob{wcUM6CW0}Y{WYoD5+2zFM)u5Q+liUa=ZN0dvFR;sLpt@wax}{`F>7{t1xSRBSxy(SKF<}R&h@C(7&U?`i4jyEKjJ5Ftl64(C@Q~Er5GN%^PD0*mg9KS&~YD6Cax7U}JKTu`2;)hRez_#*nPVXxw4I<|6mKLUwT#0BE{9nz@&G_%(%lm{r+_R*A9)@h1jNJVXl>m zkp8(sDbbgfMf7Ms=cow*Ki({FzC2!5Y zcUmD1btkB@nRPoo85w{BnCV#B+{*r?ju6+r>!jll8rjYsmx zkeTq>?{VIo5y&C>=w_GOHCBvH7Q4%=$GP6;^R?Wh<6=Ge zd*&_?Jmh!HV!2v4Oi>IRrk7L>Yv{$J)9S9BvFy~1w+)#agPeJX%LA=FrqQiYz|JIk z$&bs7F~){ks+l{y#ToIj?jGzj?L#Zmc>+CLir4m}KBtLUQ?nb6lPx0~VY~j^V}jWz z(KkJZYB37K{XQb-LmaKLw~@@CCe>iV*-1oxwebO61%z)`V5>~*&GDq3aP3z&mheln zs0*8<1!nD*@0BCV79$NgeB+sSV75#Sy#~)9t~XQFOF^{yo(HMOQ_X6Nu+b?~whg
3VxDmpxpkMWq-MJ!Qf;xw~gDbMaEmEBF@;?2R4I9~s1W z^d%>s_2^0x*Trf;>NqYkPeG40b9UAOTg$YEwnijQpfB7xsJ3K}BO6jRej^%jzzQ5X zqgQmB=k*_i%rfD+;NSzm*1`WTTj!3#Ciirn+iI|23;+c*1F)~W3duI41gygM5*B5^ zb@LqazC8BxoyAarSj1;_L2yTyo!yYO!MMl>Y8p#-ju(9b6Rc z!~m*XTl2=jYUWh^0;g{N7ybhRCY2cI;Hg*tryp*KO7v7*MZ2>LUJg~?Sf?k<3jB}u z7}3cG(%JQ{*oRK9c^-NEX7gVD$a7^+&t)bCH01cp|Z%6qPgKP%*d^a^;A>Tgiv`{QBM|zxz%R{6Jw= zcq=4GTZej*wMljTyY1?zT-dB8P4tkiDo5V5_u4~FgKCbMTA%x4)! zq)UPsr}Fn$qd)!~B=n~fUe7=rcz$fqpKge@^v8rOD!ZX5jOAz7%qzQJyd_@Gy$qYg zwQnS!;0;wg!`TN|V4~iYk8TR)50^hhQJhqvD{8Re1AQsKb_XYmlV?>GUNfm=+rp0h zg}2QPlG%xsSif_&_(6sj5K3YGYKN8inwaKI2B1z;EP~{%vu~JKo*40Gy7E;{E z4R5`(LFVUbD=TnBjX$?(j@F4xPFrhoI&lrmK6hRt7iQDrIgQm*WmPx>2yA99H@+7) zM56gYkN;ZbjW~U6-`snJw`7JIC^#Hv z$8sw>*H^svO%yy+>U_Yta}wSU{di$^%`2-M_6gv~rcf={oP0i5B#jC9D3%Lh4EOP| zf|<=T-9djer#j`!9S=Fk5B8>ar&Mh>wbGCJ1q1R|)aSo^fc23XG9<)k1rBe|$p`sa ze0NIof#WGoS6rJkM#x%eLW(`6gi+-i$5a0!7L|P0t-jD`Cu*x})hK^nsy?=pQ#zXP zW;^sEuk?~}Qfd^pw&|qKMuXYhbDj@=dU!?_UIP;-wIbPR2rQraW;#yKk_89oP^*GB z2WJU++Rqh7zq}bwQVjeA;K1Gua$GrTtmdot*4>B~*;^{!P!c~?Ti70Lcpfjh54Q(x zHz3;PmpVZ;;yP+8@22cIH$A#4^zd5vM>)NHbZ6gP+Kq}0BqRuowDwQtt_@PSfwv}- z!-=_uPM2X*w)LZ)$MYk1Q53TBYChwsemYoPbt~8=sVSLH+^7(GIY{k(;d{sT>fS8| z{o&QY9c=T1td|57foiAk!7%MdOi%CoAGeN#2Qt>1Xf70rH`pbSgE$O~p-M-7q<>f~ zsHMXZ>pLQES2<-mI%A#kRB-la^tI+*y2nX zJ{+82Ir~}?nMPo0+g)kH`F_+SBps~SHLER1x>hqnl{wGL0E1V1dJJQmNba$+DGX9*Mp4=UE;BSG`9)_6z#o?)slRCqVWE(7n;gxc|kS zyocID2joqKwm#SX7Xc0h?U@RYH!T>cG5tSMoI-agPC4-p#D8|p5M0$+cvd>J2DIpsllJR*-;80Y_3!YHr=EpiTu|AbHik2B(~V8D5t!Ro(xTbOUs?;^%|mRucV7?EAOJM2vj_P@F4`=(Rr01WgC;Ly*L9Znyu5uA6c7Vd%Bkbq};0NRpYeuLbP!oeWVODWo_O^?Ws0ub~{sNJyr-?W!20> z*4xa?CF@tL`-As=+>Xb2xnLRlKKLB7ZSZigVnWi<+h|LCsdg-%+Z7fU_X6#rVeCn} z39aPfA3)c3-3^HmHC5NU47>MN`(4ok1m$rBCWw&VXZF|7w%MH-momM2o5^=Wli^zo zklP_|4b;=v^Rhfexjy@D!<@D=1y$2dJa)r$dRSj2vlJVcw<7; zx%B6X5|&Gipv5t%q?>&NM)&090#z%}t%>pkp840b0jp0By%_@%v!5u@#W70#(ep}? z0eBu8J}KjPjA(K11K*_WHyl3LzI#*O1^y!tp1sIEB{y6pE zGgMXdxGqb)$)cVCMTx>S(BkW3t%3pYCBqCcn)CDZxG*sge!;bh=Pae5g_I>PV~HJ7p*j0n`)&t#ZMUZRxEIHR?-wMzcL*nz+&Qg!fB{wS&HHZbP7DtRh%2^@8!9sN4O46j z#a{h*1Hb*PnZfNGuab7y46r@QL@Q;%KYF+2PO5)Czud|)!bYBV=4s^)yBq9P9kgA) z<9&DicxE$w!6s5=u5nVi*$*_VP*4W@Bs%nkfAEgB!m577o`P>Yb!*go<~%k2!Md4a zkpGE;NxnCpztAdghLCg3ko%9LBwOW1wd0#FJm!VsN1df3%kzc{2|)LINU1FJBn_Ca zY7E2U%pS@Ap_%LRtZ9AHpf$;U!E=Sh)8>1;o*d+O7B-R(o%4F8xCgH`Z{F~XCZDKf zQq+n`a9^M>YXb^DkrKY402Jw$w#$B{ih)A|&a}Oe-b603q;s*p=WkpXmlSJk=$8P1{Izl#O-yV$sV|vsm zZszeuyfF5f^~XOU_kyse1zsq9EG@`W9z=?=BR&tTpu@8d#ErmTTp(w(;%K)KvV zok1T(1)*e2V}(N~E{$nd8`WdOgv+aHqpSLIP$_ZAL}IayVfpclAQTz>RwX+l!=BO* zS`tzt#u};hy=2rV#S(eNL}I98K8Lv6Z-YAd<88||c7ffpcTct^aPe3XF0EEHUdLqm zi-)TZDQ*l`3y3-?!$lq1qWSf%&jc1iRIt`h8hJXYpz`iwIO}&TnMb_7@5(0JqQ6{C z{v7p6s_Pi_>ecVrXf0|>xrCKF++K<< z#-D%o>A~B#o&`jC`!6%+5h^~&?~M{u3-0iXH~W{AaIx|_Zx<->jZiyTTLv0;z!Z)*@Z8{fhpj*Glqvzh zB?0@daJb6_M&ze!N+f(dg)v-ypcuw$C}*rcLO>g!ZIr~EW`C!rj1uc!=f+-r$bc5p z1I>N4KnI7oo>Ja`HDi;9C(w^?*UxPHGJz<+(e>BN!K)oZl3=f$ABen70EXcJb8H43 zi#?>x^gC2{n`(`HX}rTLu*kHt4pF;o*YttVAXSaW6Cxa{++BVsB?Rd&@f`2F#~XUD zP>rN?ox9aV%RHK8!~WHSNIJf(Y+Hu`<8!TzzX!;IbEPzZ`dp~ItIpNo?4MSdVeK}B?a;AR z=M0JqmNG#}V+3e!1OxWubt^u4Up-V>`o;9QiWm50PlIr?>9E?`)*x3u>DyYdsaKGx zoMCmr+-GvsVB<+BAv&m~Bxnio#nY@#RpB?WoK*KAu=fA;N)}~gt6T;@$Piz zsB+fU5kitp)w%#Vn*?zQMCnbHkwvM<;yb0vE19XB=2gI*}rQ zvXmF$*=#uG4r|Vz$1l{9*R7;7JmT{$!cy9(-ZyHV9;|FlI(0YpV{U{xwHbL<^0rPn zw65HAp9RDymH$kFKj(|Zh@0I1#YwKfC5Cs~az~H?iqdUPYSHMFE{BU&Cof^y#|$YA z!^u@*+0dWfd)|qRvyhsUT3fd%hruRE1nb?@MxwQlm!Lf3WQ;7h z;3YvG-ADfnZl2jfKUU2VKbt9|@yi#|U+g$Cb3;gO^SB&}&L~KCm9AR0YL3Pr7S`3Z z!_ABwiyv-;i!ADhvF|$}zBs@5Rxjg`m&f&5L^~7uOhr55H1D&~i&DFeW(;a)Y4)kZ zeiC12L(hU<^~gua^u0jnO8rrf)VhvrmJ9l z+-cvN4R^UUKTWf}z$dQ1RNjr=<7Vyh;*bT$3jPH5G1pt+d<6D0vArOcXEq97bB_Re-3W`_$#$d3@YgHZF{I=Y zBBk(RTfe;9we>2On2_B5xl#Nuzfs!_vJ{lCB?uWh-_F0(S*%X>=6app@}5zF%6)gX zJ{KB303;R=P5o!&Z%V(5?)kCM>sHRsx{WVg^$F)r#fsh7jhm@+9Sh3&dmpkcIiGud z&a8m4R=oPwCQ;8(?{y&glI2tRvVOTN*PLY1L1U?X%1IOZE?h9Xs6RUvfWyS!@j*`4*PE{nzH+z5M+^!un;Yw#5c13LX9cN8reHOxx;*1p!Z7A?t3QIea? z0RavDx2-i<{mWzpC&$vb<$F*$ztZpfq_v2j3TZYshkHm7z^ocW9s4SG{oxb=&D5*waL+l&go>N-xlC7vx_>mFHL1Gd~v>+BH) z_*orKy#Qo2;#O%_4pD4U1<@~lmB4igaqcbYd)c>Ev^k;=bYHxXYf}Y!Y}Pl$$U=tL z4*q0P)Z|gMBm(k{iJ?M>+>O}sn_tE}=W{G^)$QoEs*<*9y~jep9SHaTs^;`EywO)m zPWlV=e1kmyLDn5*W)0}!K@k>UhPFXZCKXv`2tnw0=3mJfu`P#4#O0F$1;bvQwvUVTi33t2lr%N*)i

Oxf)Kkw5)R!qvRC@ax?CP;zLissJ?pmtAeYaNo?2F|r3xX2<9|@8O z?n_tWydi9sLT_$vMn^;2+^g!@lS0l!n3>{y%Kd~&Oi#>;N)U0LZN<5Nm?hkd*a`QZ z!GT^~%r$!pyt8WKr8wFV-Cu;j>ZcZIajUw0(dfA!MsJ&*iS0D`%aa$-(Gux#El)~g z;!nA6>;`*|(}-F9%G9FR!pwR_&u&8D3W_oJlQ^w498r~A)74ooPT0UkF7>ShBn<75Q3C+={aY3CX%hNB|^R}ycPkzG)ly?#{M$OZ+ zn6$(<_iPCZg?X68E}q&U@L8Z)@&NsPS%9P}t|XiP#V00T|X(*faK z8QMSE<@I!+6$`@$FimzaItX6df2#WZBKeH5#rT-aDYAKg@r$S)o`p|KkTo9Tbua&i z19YqDtLxMA&4-4cX!H&!+i!No_g!5xw&(ZP1G<)yM@A-PDA#cGO{Thd6&D=c=1lcn z)(Q|0D63Tx1M0>Xc$?Qep!or4xqJk)CIyz6SVs3hNunP0&?#W}&WO70(s+=}^A&sluK7CFd&*JK#PWPNET5Sx z_&l>RAipj7>Vog3#DcHd|-$u^&-<;9!R&e<7q)c(EYy(GsDRFz6k-ZM}7z4U;Hv6LS(yq3v?=1feRw7!WTI0j1c!1h&QtGaM_*VgwEJdVX^%>YwF)+ z)?hLr=D#IiCL2GPPX?b;;8cVDp#NqbmRCi7QZw1 zu2a$}>}SYNaalPr^h_YDqx zdgZ3g}?1wfs%fx{E{j}dw`?GXc;t8nn#xCa>Xz~GQ z^0ZiJ1FZqUTqpQACXmHkW3Sw06zk7@{+lVX%n*wZ5PAaYIF}4Q@8aykG3%>n=9#JN z0UWyIE5wQ;#mSW;MLW@g4z~}_u8&Nl$rwO4gf5~#ypYb(cV+0pIaGs9s6cA0mwx&S zkK$5wznFH+77waBQNHbHz}Q1C*sKr zt5ua8*=crfYX4}jug~?YW%X+ytjJq*rjF{rD4&RE_wC(>&V#FO4JQ#CeK&dGzK?`~F3Hh=c*3rV4^^aD(Gv@9GL0|3iao8#v1ARq8unnhAN0_tf z={G%o7A98e$F0GE;lise1XX0+R^h(O`=R%y@hb53klr~ENd&{4^o*MVjuuaB;uRB=-NWs4*HfmdNliOsQt5~M7X(Z$ zPqH4RGTXg5*g3iGFmr%EVw)ibLn9G0a>YCc%fqeX7$aBsRAet}1w=Wy_T%Z7rR?8P zY_!rFTMLb#h`ut$N_0}!DOq+-9^djk^XvvI7{Vd7r`&2IH!Ahb%@Gx-C0TJDwXui6(hy;r1a|ES0m#m zr;>=!=v;NepGTDmm|283L^-%_)%iYVe8%BP*L~@O&bSllfk!HiCXnMUr&*wAiCE^y zeTZ63|Jtc9bTh@+`sE5bMYPFd|Ef%fjq~}HDx;kRj4VvloZQE3hI7X{*El;m*U@Dp znu+rQJJM(Ln}T91>(Z#vTMyjEt7|y=icL1i!$x%RF;KD`i~XyVjr7t;%OkEkUKz`> z98+LPe5~B<*Xgozf0;@g7xDSQ==fUkik)dD_{DbAsm3_&1K)>f{*!J>WR`LTA2)5^ zPHwYSICfu3H>h=&1QvgKOx)Ai#BKQ`&h<=ToXyoT;(51lJf{-Uj@HNZe#exv$IDJ9 zcu)?NCFZ&pB4XP(#c}-9tIQA*TYb}AQ@%04NGeRGunnO9e zfzxe zlR6%oZ!|C?yTN+>iNLw3YKatoi2FnZhlRgPXhtU5sI*e6ZLnFDIooSJl5w_~$T}~B zenDq3jhUwLn8(rxM}EWXA=e0ZhJE&uxECI%)X87`sEz<{I|PR$?UCVCykLUIdD=aXioFzpT|Q`Gp09%Tg4LWxQ2*|%bs3s|pS5DD>5s}tU$OCzD>eN>Wy3USH5^aZZ~^li64GLY2F7_M&PS@+{`l0`r)dtYX(E z>#E{9-d!%P;ORnq6ouHB5ZY!;aA{i$or9w9)eEL*(T78k>d>3ITudWZ6H_Dormtfq z$a?Fp(HR-}0v`~vkEK|Yg_(qsns9S)6EfiDlQmG{l=C`HUv)>a?L8rxRloSP z`*h$K^n{64;Y`-`@yFEEA9d}tu)EW9%{9Y3{H7&<)}iwXZ{45lY)rapTH?L~C=zsW z2@65WHW(W)n0B_dwR)fu>q`Mf6>YZjcFvb4SrM6f9J1vph?JxaSA`MOhcQ$uwc|+0Pe_oQ!3nxGq?pZr2Co!`CcYl@YU? zTN^u_4%DS0a=X|5 z5*(%RQjNrMtG2cV0jAU>>hyp(ClK_tD_X&MS&+#p4#)<95KMVJOac<0&GbU?$b9{m zz?`{E+vc0xXPpVdj$c9_fny2cLg##RxCxR}1!325H-;Zc*_@B!Dy2T&+rf zz?VUrm;2p`1@njZ3aE}dcf3;=&fW`U$Tf{~c9g|1m_n7|8EyZ%{NY*MaFovq)e#W( zZ>*JRA5+dFd%^uO>R~Dut?BzszyqDeVs^NHf;TlTTW>S#!Qv8h^6?4;rj8|=(C)Q( z5|>Lp%o-ki{e3P58yp#pm22+5R4N|o8(UL+7(Hvmm2&jE4YF--0kIE@57n+l&wsIv zen`^rXrOW99<)g`|MYtlIf}|CX2!p7;BccDoXL-Wrp0V!@hgr^>Q_IRpO{C5STLjH zq>z9&>_+j3;*#IW5dn#>#bqu!L=7+swiuiys1^g&CYU0BpC26pVC zW?pnjeY_q)OM(X_S<6MsC$?{DGW+QU9bYCyXAFzFy|WMk&2CLwm9|E#2j+P;v#z3V2zkiV8*ouG%h>YQv!Y> zypo=NI>rUwUdLPC{sDh5e^`yXfZ@7$_yV1AzFwt`Ve`7b#joK=JfaglKdCzN7YNr- zEl;^f1%)+&ASK~1v8jlR`*oL@#?rhu+Px#U8gj7|mTJCJRc3Z+T0Wlz z+Ii%k$S@-a<9oKNeDwo|4$S&SYSh}4Py{fRTp7q^z-KjGlbzhbA}w5Tj^86z&LKV4 z8zwaKag&DAu2E#bX!u)Q^|qCDI%5=t)2;*khVSG3YBM5|m$sH~apXf*U$uhr+v&G0GClaH3)h+Dr{9%t zA;l#5whtij^@xcw6fw}{$o2ln$<{yHW-U#yjN1KjZr_BIgJ3PWwC7)PvQtJf;SezF zXV7kzpR&-%F(QS=YViMT&&8kZ37M?5L*N8bGFV2ORr;ljK%XKx5k+JZA-gmb-o+;o z(=rrgfSo>OZi(+Di96q_?@e#k%#DIIxR$jU%tc}RY#6Y?3HnF=x?b_JIR@DB9^r`r z1@|H<+f8K#u z8#iaaZ4Z|BtMb3BeCo$KX|{uUx?+V_S|bM#Q!esu=HMqK)vo;XQb+Jh9PRrDj zE%yW*lUR_rNCOWrJOBsA?wW=vuUjIAIYB|P6G|ZL)Xk_d=CIC?cvmT?3f>Tp%R`k?>^ttt2-xeH8QmAVcyI?H)G(_LFUj1 zxqa6}^Aby5-r{$(`vV?ckTRS5y_0>QFyMK1%CA>@2SYnfFVz-Yv> zv3w7YN>Uerr|JJ3NPrltty^-?5~WMdgRp$)=)ZntGDKTSax0};_gHAT(B1t>LK^W| z77)?0nIow9TU|*hnO5NWLdcgaoYWXD*!OombpiR!NBp%@j7=%lU4GLvfm1!5XpC4a z(M|lWQd4SNg&5R+12M~QMulc-)nx=<@`0xW))Nla0bdLhS*04ATzvn0*`V3oI)UEK zoVh#rg&hk|n~$aE_#2EbJpww$eh`WYb;nAICEY!^w_3$$EABS5w&R8ZW^!vL^q{Fy zy6W*5ss_*2t2q&tzLXNziO=xV%QMziPMFUZA3&)QeFSW3f``ju@YRnGz$w#4sU-S! z9@Wv3ywejnO?&HOA-GuU131*t-6b2W6jo?U0}UqV71wn>9Kx%7RxrWiVjWTZwJ+~~pT zQ>x`dq1v>Q0ymN2>o;MFVvp3{i8}-BW-qIU5m{tRv~-X)ObQCSC1d|Ih75izs%mva z%F$m|6{DIR>Y9dB=dYttHBrRRgt+})toh>|EOD&D>YU&*5zu+@}z%V z2!=Kk$P(>=;$o8h#1nS(- z{}?*HXI%>s%Kzvy*!zS@^+UAr#jfD7g>a!WxyUr9qEx2{CLywXBh(?NiV6(xO;RXN zpD=8>zlwnp*>l}%JtwxxM!VU|uS;q2(ZaD|S9>o~sAXsYX`&qQOKlP`UN7$Jd~(6x z?Edw>#JX*n>un7m{#l(|I^>;2_KUGk`Y}RAUqKJ7r5=W|us^7z;(PS_1t)!ogcS$y zN3l-(ibHYB`smCS79)kpB}g+>^-}}#LonvJPODJWpHjT1kk;>6+(qFEC*!qhe1$pf z*S)0j5S(o*=a*s8YUm_ZU5K&os4C`X86~h<@16ZM@ZP7RVEmBElgKhFGTFGR(FZJ( z#M%%q-|1_aSR}L{1XL{fyS;nkRZjY1?FsJJ<(Ba-zF|_ZB->bc(-t~Xz zDq41)^5Z^MhS)_L$q<0fTn5V`+rz{tX_lu+jQuhRXdZt>aRY-i^_eCc7kInS@~^1L z_sjy9QvI%dh+>6Hyk#Okia3fged9 z<@>l9-O#9R>6OlMp-Cg0b^_K5m?Pfv+~a^gE2k+^5tMO&==;g4B2%@dx&N4zv@8!H zo5MLM)XBnpAFPJcSG1Er5A$CfF(dNCwJg$<>GTX-7dEBIUST~9xl?sdUx$p7|IggbXzIt6kK9Q zZ6Hti^ao#bLM&hsQnul1PqzVqNxm9!cspU1)hOUS%zBGibIVtG}?7arwQTg`4Mm#r-D0&^uG(%0X)Q54+OdwK8gw_nbD zPNw6$3wGbdyXl_*2O%CPnHPvigeu0af8=Br-L10MM!~XP>{;#6S>WE+hdwz-|6DiX z)UMR6K9o_|V>+NC)p-yKt28l}ybwD-%(8!j|07oNm0mgQ%yrYkW_2S)ZN3Nkn(NM? z0GzHW+$L#pD><wae4Dh zC|6k-@Z4(Su1)=Ud^&okv_IV|X5;^+Q_EAd)mZUTsm#i-Xz%`fVH#Sf&z-D^*HJzy z=k+81z1WfR;S&`9e#3kdB$9~FZ4U9k+1muzB1=;At&t^YA)iDwW#?nFcP-}4Ih|b? z#7wlN7vnTV8CNvaS@ddPM;9$U9W+dJDCFGccRkrv#L}QgZP%j@2c=GiVPv6Sbh|G+6>f41ojvYO&b%3Lm}=v^9^lD7T&Cq=c^aGgLP+c?>WQJ< z%T`KCJwy0B$FuJHSXhgY(_Eq{Uq|z@u6m%@AxzE-Vr5Q+$O?DZ!jH3gi#O$vslQSc z=*zQYdv)zGYDi*AGaZC0EOQrV1YQL%bLOz*3%cpFYdoZ-ry@MTrVqMEPW0S#&x+N{ z%$}y3GWcN0FpzM$Z7gW%_5FwodH%Nkmlt!ucJ8Z4yOys5dj=roz~?_+c1x?RdxXDY zxEHARm`_k)O)dT6>Ib&>M>{q3RJaNks?O}PS^nqbVna1O(E3TkLTyk##a^5`N^vzo zZkX-dbY!h+ri#mHkQ6!Q8;L$Q1(*r)8!HcAl_~}KSnWF~&->%tjwo-GU!4x0PizLW3LwT1s% z8Y?}$6Z)O$Pts2fu>jwSy}oYy0A>3+}k1&#`kS}*f>!&Z6q0)hy+LMu*@$kt>b${IbSWy$YCBmONhjtun|xFE3VToKNz4kzd3xEz+0#XdN-+ zUd`->Elrf>Ai}sTul1+Q?YU7g!UQLqaT5jKJ*fX-F8w)IjQ9!xs2Ysq6|{j93HQv{ z9@gafD2Q==?=WX1bM4W)+5d2a9Jl8DRQ3g#tZ(NqTi0UX*JRBzDz8wL=sCFOm%GLQVg)_PS~0% zz26*9Xrz*g`j2quUC>iXm=;(+B_TnrJZcY9fG#iTGiqny=Q9%Cg3qnKd@$Hx;Q}7> zSaoFUqYk-!-{0Y7Ke8O4Bq(33d+4f~Fy#qy^fVi1V*3agm#a{}s^5}!jq zqrJeStvV=nm*89Jea-EE)7TEuk(uH^vzD!zm2DQpq(XnqtQE!Q>Qx|)2mLI#;0ISu zJIut{iCXE1w0I)AMKes+^@2f7q}&6I`x_Oiouf^o*>V2id(7YS&9_6Gal%19j_Q>$ zRN*CQCABk5YX`2WR(~|YUwQ$Bpg-~+dVWilGc$oM64RucEXwswzx>M{`Mk1zGeQc? z`xlSUjkGUTo&R!||Me5dU9kX_ZG@>9fBSR)&^Les#f^e3kHty(F8WWZ>rX7}U!M*@ zi;3<}{(leue@E}1m-yeW&i^jn|HRJ! zgzkUo8$fmZ|3c+_VYJwVuid8kCvylUJuAx$-r>euOKgvCyXD`ms7-$BU4F|}WYuo> z4`cFAlH$(TX-`)PKpjmty!mVebp7G%B} zgyw^KM0{iK;O!ajxrHn#?7bu!5>^2Vr0~Iq;Zbc0|Ml<*RPTHRe|^VP$ZJ1!zB1T2JC=Qp&0 z%4mC(JTr3#1FMND)Gd2bWA8K4SqINQ{+EG4JA*cm84z5-?QM9bF;eU%?jqWGQda!ehDkF7w+b$I>Hiingfqr}(mI*_)+ydT=9Z(Ro*&jj=>f z-@YdFSfoK6SOW_U+5_>U0?*amea+|IX(voF4c()4+;lZi&*-1k-cxKtUC-@f+rwMo z&*8UVTFcGMsU53RShd^T`u`#9^MAkM`X>wEpQcwJ3o2n83vI|`bOC_Yxhx#pEZD|E8(E$emCMMsx?Q`+zW`2dT-owf z=>d@?wzAtQrv~tyFZUL{%@eUq!=;Y=k5y9si6&rDsQ-NR``5N$h4##NiPkGF?DeIP zY7yTME^QJ46f_i*1Nh)i)st^&^#i%k1j^L0TmoG!R037A#$CyilRD2r#RAYz?F_X5 zcAJh~oT7c>qR^m=N?^8meYF2U(=^lLgon_98i(!$@@n7z-8?;&AgAc~N6>CP38E=h zq}(!j>UIV#!dWuTe0AU>YJA*E;(z?V#=u6fH!gIwaU0*9%VBppSna;E(J8fX@V1U8 zyO`k$WC3+kXJjl0gho0@ae)I{jVX}{o>!6ZpRO=1xu)%$=Bd*R$M@iQyZbK75dH6_ zKQ$i_9Nw4igp=MzdV20a*Tdi>XeghiY8NPAGp@hZRyTS)o!v$KC@B;~}T3*jqo#U=qYPZKP4H83xG!lYzBOOu#A|l<=Fm%Vz5+W%| zgER^Z-Q7s{07FT4cm9sA@4er9-*tcg%o^4@YdGgQ``ORV&rU0&VX|NK))aoVi03`Q z6?)LD%}RTaVz{2NA$C3LbG!#W=}(oB)X|-QT9eu8kEdG7-AgB{X1(O9OXoY(N5VVK z*TxL;v9uJPDqi=sGnd^|dbfrIMF&;G0IBLkoKZU1a1}QOyE| zE%+yOa;5M>3>`%eit}S77lv z_dLdIdTvG~HOA?^*GA4Y&^>KatNzJ`^a5`pw{#RQq69=N@U;wH6h2O= zJiS9PdPF=sBD%e8Of7ss*CYaNHon_7Z=ZNqQs#r4ldf@im2u`2ZnNZ)K!nR*m_(+A zsZTLXeVu;d6rMsH+$uLqWy=5E;DuR2>2)FpjFao>nh}fdCE{4klryT-r$tI$u%R}p zeR>0Qo}){VWmgX<=p~_QF7{lCv}f4r-D+Y3aUOmmz$A!?DG?{RORECcXEZgm6*$gd zr3eR!fc0;IIctVKsxE}ER>(>N?LzT)AYW9)Yao~ zTu>n&jI?klHO^(*9#W_>!@P{v8R=aFi{B^yq6ooK)NsZw1R37|D{`eFLT2CO>BQ$z z)|w*2`qxsF`&Ba|H<8p+kR1X`P@Wq*?B!t-kfhZN<9yj^AuOPLWF4Vv?gSQ{6k(#V z;!b_`-#!;p{38^4Mb4sF7Nb#`pahTz*P;8#8iV6|Dz6=3p4FM~a&68ouP{V(2cGQ+ zL*@L?aTL5xJfVjX+dv4kT;CPS#B zFyGj3$sS2*c7(FsaQ4ecNV!)qQW_`|jK{DyW{>P)WR6gK-U#z7f6f@k3Dr^wBSJ~x zbcMdKaImgnW({o}8Grm-7;G@u)lGKU!lA6iO6Fqw(ucB4>5NMg8n%Hv481AROkAwO zIotV|UF{w!6LaoG{sldjz*eNR0yWniB9%~MJlWeY}x?{$&X)irzTm;0TI(kp%nvuFa-ox4^g z#+@7=h1QW^l$Phyd3n3<+o8s*Eum-DQjh%5gQ;h28f*5bo;iLowQwmB&i^@e%)=Y? zL}R@VDWDxM2-9t_bkqu_q3ca8WV8|2hBCtDoQ=&=XL}X>-zT>}a{F)9`!0)YH>}Ee z9z!_a4%2GJPj)U?LsA z=XJ(<<$d<51*c36YiD`@?ZOZ? zKGZXsd64174hj<_NCa)z=~2_ds|ci=4-KVGZTBTQ_EkbZ3dtL%Uhki{;gae{Ap~G? z6?bNBn~3Q#4C=`m2l=0dL`tG$n&8~8bGW|82*$BR@ATaW`{@;X5)!1Dsx@8Li5Elj zwQ>5alu(uKxftGb04?h)iLtd0dn2Ozvfj#(>tJ5=UJ z=-EaD0?#t`!kxp+&h<8=gQSD?JFbpnUcPvo60`J=!;a>UtyC(@PUiZsGtHZu@)jC% zbk?$_pFRG*MBZBLw%pAm?B5Slg`Z5B0` zyC5?XjrF;4I2@G}$os8rHDA1DM~vJ3Y*lY`ByQe1Zdf0?bLxgGBu3?=RLb<1ei6_r zsjnz3J^Lk;>y~--B{3#pjrT2`J zv%?LZRZsB6kS9wcdI!|l!yUWPa=7xeY$=c&Xq$rwJTpt%$0u>a-sqRckwQ?AcX;(* zk$d_W4j}ycRZokKB%mCRQ#h(k4e3bM_YxA2bbTZB4D4gSaR+@K_mw!t&hu!elHGuG zYl{|M%u0=E;}en_6gzUA)?)E7^z#BcP*3Jfv~}9vsD4^tcWBziKZ|Q4?_II!N=l34 zIq@~ZKX~7ViN}_7`>rqM(S{efpYQ0HnR&(($4!L39-T|Vv2Fd{n0w{kj}3T*M(wP5 z1%4)Lk=S}a(DYsc><(YUEIT;uFV&VF^d2`NwhfQZtL7P<%Ybw){^h*58$Z7);#e?Tn zRdkxp0$+C*%{Yc70`o4}6udhLwnqKedyP{5|G(F2Su0XKj}jVA+xP_4X|Zyp2!Tzq z5A1JeqZaeiw_NS$nwZXgv{rbmH!>5ZB}N(&kOR+a!s(P&+u3xznnL}IapCghh_?%l zlg(bLoYcf<%p?fRMerwyK@j%yrn3RbmAM*DT12=+;>_JF$t?hhwQ`9FBKllN!9;>! zwP5I%QfT)eI4G?+*2k+)fRY0&J3)4-YmGr!wB(_k)-<0I0`n)bgxG)C27j!oc!u9X z>Bf%jMu;O@C1lbnoay+XljFyLz)8O;vOq{J_qq^@-y zotLr)x0F1fp-SI-H)?&1?v*UVct6jeH26iqd|0J&yKHrbtSUl6XpMO1?z@s?#r#A) z29r8;d35$jnsMWh{VxrGhXS@~fV16Ph>xF*4!`Bs1s;{NddX$!u_PzTo6cy0;tgG8 zVQXsEU9voXLWHP@e}q2zJ^|K2gir#i@GHh2aQx+sRGZKhsC8&3aS#)tUuqM9y11#OB;Za3;Em=bJ83Nit~qcuq7OP zCZ=XgSqg$U|N6?-#2NjR0x4UKwzjJJJ@RPC#k99uFq^GvJ7vAh{P{6`)AyP2s43SE zkx9W>(`U&WYE!@D-uXLyT7d1}tBh6q6&~QVg_(4%K1X{@@Zz<2LGzZ&HMCrT6MJVC zMU^lhRiIe)#kAc(y!QH-t{9fDiMcXi43*D`Fwbe-giY#=+aFK-{%tt_`BH@V z+Y>(3Bim)lE?XSnPnf%veC3$=>-N4i`)x={4{E~Vb?lYL@j$$7l|Lb0C*-#eKtfS% z+vn@v!rwJ_{`N;qnPXL-2H2VkO!B+T>eb4gb<#;_vjwA)GB!md1!nT0D(vabvU^ zEh*&8rhqN7uJa?kNwHQIc3B)Q4+b$Y9a`4Bjc7{JE21eJH(k4i5`9a#B{F*yX4~d` zb*{QT$9CkL(%AW|_q?KuYi}wh8NW*{G|{yG$1=;00VQMMuDUf7dR4dx{({zd@}YXpoIE_%pxuhQYA1njHd?we(M$Wh@F%TT|IP|hAp z>pKpu7kVCf!09+F1l>pxG)-=@?uruPD@5+Ez!00}B(ZZG6Yh(8P0U|UQjbJwVL~98 zdU?2$WF^_dFb-@2RsEk1Sm+w0l6$bahyg{DJn~Pt8@e?WZamKpT5@%70YgMN#k=P^ zrIy__h{GEEL%rCD7(P01tvk9?7oDGL>kgPuDVQKbW@6$L793Lk$5dZUTsY9Ra5wp9 zOXK#wR?qQTA3fE`O{C^vd3C8r0I17M%6ZYI{j7!aDp;PLrXPIg(j2H>UCbr=wn**} zU-&F>*ah39sk+vc0eo5yxc*BoM}B;na=j>iK9v$H``_oE1fnY7zG-tik{cu9WtZ$N zo)cX?QR3S58P^x!tKu)PlvPPL6HAWY_M|7jMjX>Myfue5cz-GyvfA#M{W*2{>3G4) zw836|Wx?b?V#1H$B*iLiU zhGaH&>gnjFGJ~4_Doh%MgRtzqvrN6J{>Eye1y$phEe9Rxi<8s)t)nIf=q74-t-<00 z|Dps1b_JiR1Y&4H&ualn>T6!C@H0zbP&2fm`f3$Elexp^4UX9(n+oqNW-*rBb``=^ z21TP6l+>(<{71U_uOO}>;DfQ<)JAgZE4Mdq?wlp9Ll7|FZr(0F1@5o%TyUMYUXh2& z=~j0?t5>D9Q`R!k04Y=b{b&wUX<)ir1~}=kxlx#GL$w}C4#O17=7evyR8xyf{k@26 zNC&#(Y~GNTQPe?_7+J~!BbZ9ECDz_Hx9tq}B4Pkf-w+n6khEB4$9J-d9a?K9F=+ucvZJu5H>l)c7ARH?kHqJ@{<1)QV(b`ED)M@T zV7_xipLHO8Z(;&$A~*e!?h-ipUVHU|kf99*X>r6JdK*=+x=3)*_Xi$IDy6f_UUdnn zWKx;prZcbOm3Lb!KSerYy^EGA`iUpaRQm|C>#NGsO^xRd-||bM88?hA zeRRpLfA^jeyc^k5pQyaq?RKP0ozrFge8zh1p^Ze~H37qvDFTN61g;YKQPnc32(fBL zPDIKs!3Nn^Tj%dAhcU-8nhI!CVITwdZ?~)eu#kU;gNob`$Nm+8PGt&|Kd6xYkr28- z!-~$0NKg01i7_b51y=ZZy#C}H9;Ed(c}ii_Oxr+mO(%-+)K)Nte7SGx-um&Xx7wim z4i~ODt^&JNwf^c=FrV0{j5T0N<}%!a5hc%Eo_hId^c_ zoqY~iU~y4M(acFgVys(d`GKFIk-1I?`7FDEtANfhg{^4x_H2l|Rzju^uqz0b=L=VS z`BhrP`QGwM7JV;_S{R+E@a#1uWd=!M%YMNmh@*L)?q&pW-bTG;3-DqLfh5yugXb=;1+1QK`3g_*TTqsNi6EG)om6C=xj@Mg+`z9H zT9z;l3~$!xSpIzF8HW`b$xlLjDKtwW@l@!KW8WM89ES>#%hN2!BX|dHfnR;Ms^6_gAz8O4&S2ZoELQnOl z3*OhIv-dgVncZ&~J|sSXT};u%aEneYtsTeo>@H-!*@YQ0DefA=QNJ(LdYM(6e-u=6 z9AhrF<(!@UBu<>d@W3j-XFC8TQ)fvo6~eU7S=@Ci2qh|-E^8tJChT~xg?Z$DX_=(e zuM1HH;p$>#7umk=_q*%cfgX?RhTTN4X_6v7Jfl@9q|w*7&CgK487%(vz4_nGiS{%3n}<)6g= zuOj0=l0J{00d+GDAxfF($Rm-vVeBROuEmlLzbaC|wr&;DS(xU-^k zX-cM-?DN0U8~x5n4}m>#Y5(A|#{l93#v8N&H-`tUq7*sY_FMRNb;Kehhv zLlhUNt|9!kH1LDbA8-0vRJ08RZ!^1TYwO;7haW*kAwmUA#&F9(ru8f8w8d@XrE& zn*$1C-t9-kJp1<>{O>Qhz!C6v>)34jpZ3I`%iin*ZqV}!nO=hbvEqQI6fpL?=*#7b z+x0)*#DB!Rm@a^G^~=rE)&D+u{%z<>Y~cgH|9uaRe*f7 zveEvWr}7Z?z<1^J^`> zgF6I`iN5(d@i{Jg(2IRk4lIv*({}9LzNmj$Gia^Oy_}#+^?SO*Lf#GeD}c_ z*>yTx$FVzHbr464M!sz%o}(RRbIO|`*R!<^5`m*h-YU5akEwyAo6zs-g&{9)P6;%} zD^{)kIG9Ct$QmpNTWJ?!{KF#RPnoh$hQ+#e>w2JV2c=JV-{@5Dt!wO6u2ir0DGp=8 ziw3^7>6!rD+4~;4cB%r7RCvQphsmBd^C10up{kZCaJl0iw@C*QLxe1P z;ySlM-CG8pQv3Y)&tacs`*39LxtyoKAi5u1GtN;y5Ohd8VxDx;)Jte_!-0yyp6(~#% zFNE8v84~9!JyW?Fn)8K8+s*uZMq!5Y!g4YG%+c4hUoMrmcJK!S&BgV@P0IsM4c1nj zHIEujl%0J_o?6ZQ{)&w24K36Hw$m>OO_KRrIylX%@MF9#TDk@jU$8L2inn1rFnw>U zLt!wZ72;Sw-2yM&q7TfhN`Hq%zb3iVr{sqjVT=aR)heaHYyCTy+k|zXRmv$zym2dF zz1Ac-H&s5B_pKY#G021F9O&U9vfU7}@1mMQvVyRLj4b2TR=bka{NmTOx6(0yI5ws^ zO~;pa^4kf*XnB)v+;;;$>Kg? zGSQfIR>&5AV!3Cn)K^S+xUsi{mDXCt^J~qCk3>GgHq-Gz%w?ldc-`lHMXxS_xafJZ zp7NLo#;5*VlX$MJvIsc`e1*>4nbZlWv3T9lHxhl3BsGkGDGPa=fJs>iuYDPK)plAO zRQ;@`$R_Vza9&kxf3suoS11*sLMl+Xnmj^87$a3y6pI-_drwFg$%pSN^|~JT;owxe zg&FyB|M;z(zPA#6@gS(87@#cbzTg25>fvbf*V_tM#noa%rgw3+T>M@_zV#EOeb23F zPgkr}6>0#H91jMx49po-cR)I-H+$)*Nl2$YQv4D zUs>-wZ1NHMw6u zP7_&NGu!^I#9)vCR;$|4yV85ac{jTMu#aXkmj$scirlN7e^ugkf(u)?DK$+g-my2v zndT5(@6X^j?>XU!bb-Two?$De5nsCnl9(Tw@DZi-W!D|BHBP1E zdx0P7JbTmkfd~1od9r(a*6XR*bt*f-^$NEAu4*Kq=1pfmE>jv7)tavsKHZx(riib^ zujpY#EAZp=oCigVakUI5TA2^ucf2bog^HGt znU{#VJFf+JfSSLU-M{g}L%!$_|2#0D%}`dsIs2sE{^``KM7c;q4oCLQyk*kY_fxC} zjh$e-{?fJ~;b7Fs!CYv2!>$UXK>PuY|3Iu&=AA>Gp62s?&xD zzUl4YXt_6EDpv0>IAIdkYdG7U`kBlNv^9C`=9_na(ndwXSV|ATTf;4Q0<%cmaIu;3Wc4Y~f1^1d`sUo(DCXs3ws3GO-k zAdk$&<|Q~={2|reA#!CpOn8l2F6xQ8*oV}hoZ|d?iu=Ti{O_vS_5I@p{80;eDRxBy z*l9h^zx2sN?XNjn>YO_u=)<8%7mILK{d(RKQu$nnI1Dxr-ox+i`s9KTx!KUX3Dwb1 z+d9LLlTzhyIvdCNjIjTX9bDiZ=FLAdm3^?sSFxL6X3nGA?Qw70GCwuVFxY+^5c#-C zGnbO712OgDS+$s-$%*%{#(#Zf;$v?;a;^@3M-0kcDSi!`O%dF+V!^yDtKFVAB z@!Lb`0WLWzYp?SrF5IY7uO#vA=28LiU8AcfFJw%PyLAs7ces8~$Y!1FmHiq{8Z{Aj zju`ddSu6}{3HNUExt>XwKL)xSx#TEECk6o;fO3ETz?~Z*b)(UT8HIBcnc!!Bq6UGS z*OX+`#v!O%3j8!SiM6>WBi|vIK_r^IsSs&0l2rF(g3Vjk8Q+Jy3-NW}-=NYFey|16 zeutzKjvFlXJ@xAa8I0Uu*AJrn!s@3s;O2TuwVlu3VqjN(BpaYrP}6aHuF+XL*DX7m z{bc>E=3RF#@^oZMH?WuNu0hT7z~rq4x5lC2_lLS{)bsqJ=Zvmli@XjJ();~ zh}-?X1!%yaaq(x@ecXOtgI`F5Uf&-JwiwnN4H=X>4rdi@wcVr;MA_K22fvD6DfOlb zZw!esfA_{jpZzzg>WK-;Oo0vF1?8My=Wigyoa>^=F^?@7F$Wsn zkkdMgwA5;$A3l#?pgqvc^dVr6u0&hyBb)je-cF^v+0bE zOb*oHjF-(NJM+RK-Sph9(R*V1Q$KCr1*J>j4m)WzZF-3!F^4PCJAdWHbb-Vl3uy6D z=}Arl;4_M>&MsiayoOl0U*7jQzaxd*CdfwpRrSrBTvI8e99tvCUhJVN%c5|np+VZ5 zjBxD^)KeerJ&k)H@1cqR`34)RJ29DA6W^%v(<|xyUDf%5p?9`UIg{B(A=es8PdwLY zfjPR8^5KF|u#dz;JP(qW&CeP~_)@6ka0eLc%qCj~?~9aymSDgoKt#{A4rI@5`+ z;>r(Qt=`mbOZVPMI|1gtWljlBL;5l^q)4g6)DEeEAG3T8;q_-&H}5~kA2GKBUN*?@IPCRbY~ z+&x;v2zsR+A@zl!kZ@Wrhu|G_I?~C6Pfy zYlAuClP4h2>&hn=GssQ7o^-7Z%YYkzx`D0&LKcQ;5MN2t*|)~PkxJ+&sM9$uU6xqB zvj^FwL3u6_ne%oSYBB96ep#Ov?f~6QY6iD=OR%~L^}DBqU7z&EHfL=d4v*ov()}YO zZWGcIHl#yVZx)BF&J2bYGhPMJDoMn#i2gJ6jYihkOHc!tg5c^{V<`kD`b6>P0q0xC?p94xY1!#{EH{%j) zKOxkI899}7`T&?W?S)~W0D_L<{UfEto$9&w&NWyUR}sZDAsfW3KPYG}mm80iV!W}c zVHXIuAzR*gt4RHrO`5ck;E)ZO#ekaJ33ok$!^XS81;t#f*r-NBQ$@9so)=h6S9Uyu z{8L>HO%qUkmNn0CZ%k+`6M#ptV2r{%cpmoay@$cKPY%Azg}t z3D*5Ag;pk3(w;@>e!nM*8wT3-dhz=(E;uGaBL$#lOG(AUNCuzx;Ci`EhTMfE7}^*M zUv?{`L_RoX1Z4UG5k1^9pdDCyW?tDwr$qiRxTjQ4?aOm@PJJQ01pFN}YQrG}j3sUL z8LwF>iS`0}OyXNJq1o6aBY6v>jKhufV2)==KpWBaAlF}aJ9 zBCA}ABJ1e$#=E&idWS2pakoN(&W`bEZ#Fq*uA9}X z8qWyJ^&LB7N_J+?9Ci<%7Kp~5Mu=4}7XKPrFB(^I;9$6nM1|>p4R2)a2tuJEn_VC~ zlUxGEKyO;JTxXI;Oc%I|a}PHk{u`GO>H2nde6!G&Ayt->UbH% z5k(L!-d-GW0@819eS`IM$`0GTd;yJNYlXpYX+$`%8#w4~1NSMW^D9p_{K7->u|rTo zFOfR0_%|Jb+5F?ik7F0dw{yVRA`$=l#4`FeX_E=?fJu!_?yg zq{sBP^Do_mCP3vt|5eZ&(H-YcZXU<4w3%d@{@DPg(Zj=3=)kR$;Xys{4C7y5RowG z8Ag54&%4JLS(#IG@6u_f*-3yzLc-*o9;SdGyAtxdc=c4(=~57sXoA7#Q9!2Z!@vn0 zR->4a{7#!ZbQbPy>UzJk%Hh}ZD77O#0Hv$l zbE(d?bk8l+DFDK^Meba4*7|Zj_-X;FxOY;Ma<@qfyB!j?wK$AoNPmUv8!~@Vx-+|h zU-|%WK^{I9&)`$8VdHCZIDl)-qCx$%d!VwyTW|-tT?{L8 zI0#ay?ecAwYqID{+R*&Sb6Fokf+~t!;~Oq*2npkPe=S38I3oalTk%iWRnrF$A0FL<=}Yl864AUo3Qjc4$e%Cr=K z=Pn2@-r#XQ#S6{j-8G~3c-E$f;nr4{Uw27W4y`;1C3(>}(l&x?~6%Msr(UvmiZ- zf!A8(H{*{XNR0?xE_L5%NBcikj*Wb_#jVMgPKfi?jrYfulaLa?=#0Mc8mn0+gWJ-v zx`o)8UR3B?yRHcQ@cHP7^B3t9SzCjf=GOl(>q+No$}LY zqVtBL{SBSkSfADBG@0oVZ%DXw#{%9UPAzW*Ugy<}UMQtSzn?Fpr@kk=3Uu$1GwFVD zkTJ!^u1L^V21>VJl55F4$lrKKw`p*fR`SmbSl9|7W?qihHGZJg$U+AL%68g+PdGt@ z$FZcYP3)lkeTtcv`SuOAnA5MOR)J36`boFDP+AZGJi`%7zJ!O|O#$dk?Q0kNjB0TY zQ2o)+H#8f&V?RQwHDksn>Ve~SBs!W56YU*ce zUWYqGFBv^(AiQ3w1d#Un^P!BEk*R(JcI}7stb@qcZz>%n@OGXLoT62f+I99~F3iMi zC>gvmwsL;*S6rrbTjARrraVymcN0Sh>k<9phkVj*es=}Lt7G14#*KrdB%_)RYj=3q;`I?_Ll zXnvSfj0#|0p87_Pg=GkJ#G39g5p$hCL`SFX}eI+N^qzta-=+or;tfHM< zj>DfXjIN`w(XoaRNS9Yz#}#!`>wlEA0aQ#1HG$W+&ayRuLoCROVafVJm18plLevaz ze0ZIhBnRivn& z?t{Db{BV^6ohOjp{D?mqLxpPQ{|tNJAu;P9Nr<|uUb8NU_)tYqLaVL9iBcD|Je@M- zef)uF;j%3Lf!;;H#o}Ntdo??PgQg2&zAeaio%FpaDqHMYKF>u|#$B0GP`^4n zdE1*;Kb+9?k{GX6VaDvO^(zzzAn`em5B)h-|I9MnWLU>CcxqQE`QfZT*mpGg z*hhkDAF>oqbI3`ivFQ#PpVwwD&FYk`ZlgAH^*#Qk3@p9u#UdH0U6bg{@7ut2QL+RCvF-2ynGxX zl+E^9f0Cmd0ME>>^!tTR>d$eb*ugwuC#r}jvahyhF7k}j=1g!Z0-urnG>-ge)WOP= z0lClJ`+6D=?|bk{Gt;cmF_fOEC)l(tDV_i5W`M`4k$~B_8)fMxznMA8hC7dBjGN^O zqhjsXlnC?)DmiclC+KvlO3|Ub=NO2dAp~MU=|T6$Q8peekaL$F&`l_NJU3I2hkRxO zd!vf6hwRddWIXM+{WO+F)UztmDgeOG`j-Y=iEs$CkVs_*CvD?53WdU0#GQombaCP3qXu?^b>)uA9?|8u(>!1D3{lluNj!fuK0I9t@dl#OT?Z#9^bqVG zh`F_-)S`X4>%k-}*e?USzrujgm9Sl*=bQy8bH|p`-mrhSpbj!uLAl}8ACqqP`Tc6e zG-BN9pm=Dm;sckhaQrH{{sgpkRj(#ol<$HI=>Szwpi%s1=nL`4mc5fYsmUWNUQO8 zs%{G4IRS{%xkoPJ{Pbi^{b zX;u$^OC2SFY%_fpLh#Zwr;F7O`_RXs2{=jytW^SXi7<_ch-Sr?cjE@!Iudau&er2v z6&|r2m`_;ks8&CSP$OWNg+kvSo?o8Bze}$0vsM6rih0uGi$MXuW$m^6gsmE!bIKY6 zUt1GVqj-+#A3$9hd!;_!_`pT-*nG@O*1^tpLlTBJM#6LAFDa&OXhF4NG(uprl5D+Q zTVbC{0JRyx;5ar4i&-SV5HG+b82BdjrU;Y04-hQhZiIBMWQz8&F^Q?a20G$3pbdVKIz5oF~X+ zQ+4|EjH;@ng~CeWu;bmLeOCQ)-~FY0U~M#Kr$A>I*pUr4W|ynN)vrUoEDR~%lb9}} zi!f#>lE+k{W@H?;AkK^!r{2T)m?FJwvw5mP*UQ~T0auC)nO+2*g-pM7f3w#4Q&Ndx z#!!U^Lp}+rpdjr&K4}nKf0J`g{P|As4+~C<2P57FK|#c9nK+GFiS$N>FYgSA&+dBq zwL5b-0N?cL!jGxMrRP8%<5Tt~R)Aq45AQA1RYly<8HVQqV>rk)8^ix%qb8gPj#zak zQIECQ;L6ebrXpD$I)yE5E;}x5fXY&EvD9UwXa9{x%}oa2h)jqTU5LY~pO7l#@ayMq z6=n=HTTU^Jok<41M>G5*=QzyzFDpE4Huqm#q01L;`!+M8%m0qe&pBRn?CZC3_=&Ip z5&dzm{z1nb$H)!t;5y=0+@9G>waZlzCYA^ah6ld)S-y1G9(r`=QP7QM_wbenAXQnN zt^KuAGh&C2%?h}vlSO+&<)HBb4{6wTwL)OIMEhXq{VERz;@b#*{rRn|2BWrJ7c1ZAzi;A+Omf*#MpXeGFtxd9}9GM`QD=qYDBhevy#j)XO=tn-dqN@M41 z!Yh8B*FZ>r-YB@Z_Ke#Kp!f<`9V~d)jy`bWKY1V1=JSh|4!4Rs#h*SUOSfIXt&$8m zz-0n#i$enV<6`Ee(d@ zDgyQ~Fv$=Ou26%DLZ4$i+iE;c*diB2~hfCbzYZ;_lc%ZI5 zr9ruwp)+a?pRKY%={dHbx1)*5M4_)+I6AdS>fupawCC=keCf-1y`o(6)x~?E;bGNc8ze*_TS5rC~!dtgTKa z$rtAaaSZmkg|DNifH|a%`y5S%2=_?wtt$sInJDIfNcuDsG?+ zq<9>6Ld;ix_um-}(!a4op%=Brs5j&Tm#Ud!L_HB$K#Ax^y)U4?riJRS{?cHbZ@7(h ze+pVH4toWMv##a)hTTZEsque0lFt9Y5q552-yq;juNmHn@AGH#IDDhfI=6 zay6x&UYe$*cO+|&T9&cjo=2YJWy+}_KE(SM7tK_BRYpYr*2fA|RZbk^a$oNG?eePo z;4c}#Ki)^H4h;+Sc!NuVdZB`SAHKJe$V=)I@N~S{2z^vKP&-0C#fn-x|3fqw;k6mH z=;WEWZUW&JanM~!g|xMzyKq{ll0L=hS+WWV|GY%#(oC*Np@b1^Bc}<}2Xu6t!Kt@Y zH`uJHq^)Y|GU;(XE*6h1%0>GoMWf-5=@MO>OzKOt$Lt>K1*3Zm5|IRV7mZ?X0eU(? zw$aMK??hjdlH1dPwLJT?+vXU@q0<;*Tr=v4r}?%GB@(TXL@?91J_8;yd0Xj9GP?Zq z{aC~hH?}(liRsyiTm)}dZ~klHffc4>M#|6 zdj^8`Q!*&@4;PDTZr@_5phJYx63IO7>6CMsrf(1$F*6|DKZjT_JV&T0k5c{=ftH#R zFeM=38{p%DWCEe>&WzS!ZwX88-+odJK6GNtGZX~ae`j8nhf0RmzhXJzsQhzg8+$<< zU#G>@X0@oz>tkcsHqEE+y^^9v12_utfhaz#npx66S2apD#)U5Y`t5h}lBDGu04Tbs z1H$S2;D6QVx^TpB#753yzH_ZxTVi)9#Y`*!I)0iE!Rc>O35E}TNuzGmjf(!xo?jjn zkP~VFicqG%O0_XW@A2ar^;EGfKk92uaNNnYGYX}Y;|cpwSg(r9_^wkydI(JonMZa6 zOiE^ouP84PH}{d^0pS1F8Zg55*=iX%#|#p;E*1ZeplbG{UcOozZy1BcLHt-wpu=gd zX1{Sm^(NP|&dP|~q?XZmHU&kW;MdHz5>QR-oq)+YD=e|i-q5IDgFP<9uF)JHU}xKm z`(Dogv_AF(J;q-zgCB#nG!XHTX|T%ucMz5}?1f*YiO*F#_-oY~e0h#KPk$zFa|ccp z+3MTg&^_-m!b$VSdc5C~B-krvJg)924qMBT8=ts}&`pRVMY75va(4g)%0xc@(WFE3 zcoiQB!xhODS%bUs4m;CTX%XgQA1#%Ugg)idbXG1U8mg(J$+A3EknWq&4*4#(NS;Om zvd?$3g>u(ISCWZimbk|A*48o`wzcH2!I~re;Dk3?T*nwC6c{6s&Xm*n*=zc=4Ah(K zm?b=i{zO0!hzDZ>UD&9ld;L^R!_D3uQ}cE_pb&zfpq0h`vTJCJs_sL#M4Zo-y8&`% z0=vs{EIr)uPiM^^p^Bp#MKzo_G80V+PxRkA?bS*m8_(|XHK!uKPgNwtu9`akQ1F8U znV?M-$X|(iJZUS?0+PCpH>R)Pwz$U!^A~dDK9E34lLmDfCU;uK`84`SPSuyu$4}uh zd?70z1ym97$<)&7vC)?^TX!%b{T5vs$y>bT=S1X_HlEWcXd?3V-CS(rexiBi`SNf$ zMJaok>0c}W`xXwS6F`HUZW{H{iAkX`IH96P@lVm7pYlA9~S^=|?dhiRLrk zw7cy5mh5Zo>qBnP=%Wx>bTT?l!x;bC53z2QnWONYui~;oL6o%*2J4ldqp|saYOt3Z z^CKuA)@M___i*N&t+e7uV=9r|OACTPXc_;Cwvb|jvc=n$(j51-pXG-;nutBI=WKj| zweejpZz7;p6|Ej_+>#6b3~#&lzM8BV=oMIq&0wZ`ii&A66n}Q-Gc5{2(@%z1*Uy1f z?N2IGyV*kNAIp0gg`1yiM?gQ#I+Qd5l}PjckF@}BZZPB}R;$PY9kl8ADTy?w#gQ#r z_zTX&0j7L^f-XY2xACx&C>ez;Rwo+QgTdM5=V9TJS3fOaQ7~iv>aCN`*A_FGD;HJL zy*A?p0$Tgt&xzSqqAm!sl15f(A;#^?GW7%k4LamQtt~YsqVFp*$*kQeripW_Y`3v-|ZvhUbCyc;&_3hbj zB@coJ!J}@bNnMIxYdefQ#-rR4)ylwD{cc{{0x@{;EsVJ*7r9x zmgDEKu##z30Ku2oWivKuBbM z2`K^z{3&@4Oh=v0bja@w!?B4fCjuDp7(J8HR4W2~u0531uJ2*)Q~fr(wZrpoCbU9j z?H8%`g7Ey8r~1K&Z-MBFVSI;3%yLeE^GIHkSgD8_Wb#I4P!5Ao$QKuShs3s$<~BEU zYtc_dcN%#EmRc&S*`R75Lr#mfxtv|}JER;^M8Ba46RlUZt+%q}nS2~CuS@oVN!%r6 z)NqXU={dQFt^>AlC;dc6-xrn__Pu!g=XfDcLnUhiETQC&X8OAJEFXY@5A9>41M@qUnsK4&_***|sNt*OZtcZM`mY^~?fq=b16nNG?eQ5iIC%BKL?d zA2ROit{9Ox{nPQ|_GL z#Q+-Zcfw)^Z>x0$*AYBoE1%A=jIfI-KixcH!I)l!ZVEy`L&e()GY=J1$!Q^G<3E5~ zknLM>dc1N4!=832&J_0^50k`{zNp`9@3&-QDe|)}IpF~B3VQC_8;e&~RZ-7X0%Cng z98Ag>Vl;*B$T^I9(o+?7+$ySG3$QfW9jkCdOxlDYKtYjK^_RJZNDn3jDnNO9CoKzg z^aQ2ZrZVQ7&4a}2kEL2|ez&|Ser0tvNQz_6ORCpiyclsH0pY^U$X#*ZBY&zrH9&}K zuO)QqUB0`D?^BLYzh6n;3{eNb25lYHK-}AonW{Hvmx;jgjhT(o3MQ>A))f%BHTd{l z{77oLdXk7)U#mPfExEnV5Z~T-4WGQ>XLD%>9kb>*$Hg=W7u5*1bjmq?t5ZvCPE91s zf+>DX%tACUar;rE`%aGZ#&0w&(_bdop}H-Qgh!2RFa7i@_Z``$86}d!ads26srK~g zEAofO?V(zKDNiY{ne87?KVv|0dFdCqCmn@KcN6JAu4RL!5a>9tZ?LgHy=Bsm&l;2Q zzp#New!VXNicHB&_+svfVi>$1v*iT~&lN%&cSS0Sv4!^F0Fbod_NxEPKFlT!Y%&50 zq0ZNfc?~E{Z->p5?P(uvy0@nN0^bMV>1%#sX+>!PeSRqew9RG9ZzlME4mLCwCh zt#^%1f)ve1@aAOr>h%N=<`Kz0s6QC}bdZKi@k{lCZ3G^$(gorp?MOeAgEwfaVbsot zVv!e)cbQUSe|JL|ojrZCk4*2ABzM6`Dm&ELArAc+b2d#CS)NwZBb(aI+x)iqvX6Yf zFxp4-v&nJx$|3c*O<;Q37 zrnrdY&7JN$>i7;$>KO99!@uW5Wyds8K6j(-o^X^CP~2G{t}*Dwiz%O+6pZW#TcNur zE$7w&~MqgiHN=F~Qu!Nc3bb zY-y(@C(?$A^^}JNKcX z`4esD2DgMB1l#&kVkVX*c?iP@tLFu76ib!`1 z-5tUZ(n`b3fOHHY-5?D!4E#3dJkRqz`t|qUyVm=zcRhcw)@JtJ_rB}8uliiqH4l@k z>QQ>@TQF7r?gzEB9bb}P>zmu=7gsvLnf8l@lYnj`K?Q!Ak6+F4@7J-@Ye}>TzS8WJ z2@+3Xh~Kf zo)bv0kE!!z(&`SGuV|-`2Tq#ZuEm3ORw`mFTuQ}vD7UvW{4!yWthcF7O(B0|4X1xnAuO|dRjiUTAVX6YIFT%79BvNaC>LhVo zGxfV=N|?5nb<0)ekr;NmWh2te@7CPK#oG$Gw0wAu?<@f0*|FrW$mU@1w%^65G@J+e zY{l~aiwWyC--;8)vesJYh6$U6d?6+OP=U6ZE;E0Gn`i0~;J?|B_IbxB&oyu&W zY%h(%Q*N{@xC8FFG<3Ke4gm={N36)g)*R(_Z+ut61?s2;*>HgUQcHw$*+a*xn=+4~*ARl`p^}@4?&x(D+ zXYJ^b;L77HgYFwq_yi}@I~_U(9b(j zH<}^{cL|N+6<}gDRMu36d(r$hIM00SJU-DzdcMJGPXAX{{SqnwG+SZ<*$cr@)Maw6E&NG;m(R)m1d`ld)GwPE&crf?kX>sYvw_%y_{ z#|e2K8(8`iyXpQy_V%P*VT~bg34r(qtryn-XXRo2Ab2X%>)W+QhU6OLS6(i<@M}#x z-&`px-+Xs+<~+WadfYrqVMNYzs*VfapNmNAG5ij0l)uWgnGlE8&F4tIl9;czoQZ^(@!xb+Mth6`$-+Vjdv4gB=1)`RY*;wCehK21LDz8h2|W(BPk1!g$BUp%lU3XKpl&yV zr_sIe14Fz{LjNzVabH$*TEajh zORFG3!M}gLhD~^yat)hE3hS@;uEr1a^{R=#E~y!TPN#Y>z5mz$|F{KQN=TU9`RCLB zb9af(-#?C+An-p8{m(7ng%jhg(1}PwqAxf|@~1KXrwtssuHO#ZUqTreg5aL&t>2Eq z-@oI*zvu5iZT4|2)qN=#zcb55!EO!X`n- zsbJ7f(^=>dQG$`%LyerND$tq!sFG`ADc%QvP12nw>s`V_vI%X!X(bO$q+uT9infs(nf`9K7zxq1BF7}G~4)a za^*dS*SLSfhbD0tlrY1dl!!idUF>5`Hx)XZT>4jpgV%qLa=?FJ#Whi@xWi z@E03cJ3pbJ*81^16a1UUS<=76Z22sew{UyWXnA4*Wy4!}GW_=9AMzYC9t;n(CS5-u zOVZNT>n*KB73VK|A`qUN<%>HS)qp)z1~IVc8@|o@I_GT;Dg3Pr)#DP>9%Dwzs)?s) zZN>9X>;GQz*v@0s~n(Hm;hvpx}XG_Bz)1X;Y z`9jY?3+I67Wic`=!Cqi)!mf2Dq0+~}yf021zUkOvF81gs55fx$xfisYSYbiVXZNc1 zQ}_DB#%M|X24uO~dKlp;0+)D;I@45rE zlz}>g)+jM|e^BN;O z(t*CI)uA;(0f{==9EaNT@&nmqUoJE&Hnynm9iVfLdNuN2ju-iE`u5lGP?T1i5et9N z;jt~NOtx;GN9F6+Y@r|4w)6kIB?9&d9|)KhLv%XqZ0Gzg)7HleEM5B2+;(0?2%%2@ zRK8rz@JlYYbgkX}!IOh}RO?{g;38U=Y0f8X0A)DBD{joyDz3&J!bWpn{4gKTrCFFs zRYck&#~y#4qlAzh`MzW40U{QdSGnW@fll*byxc=c?=~;oIA~AGFhf@l<``H)hvb!@ z$7o@?hG{1>=H+-aNP(ldTJX5=9lXn)|DzTdokjrnArMQSteecY2f~CNCrys^5t#e( zN>zO3s&#Z_&2|x7e39c8tB5)CSX!;j<{Q@?brHmLOtidNY*Q%bU-W%Qg=_|Np(I-T z8IIcB3c!@DB7Ra8{UsVU(t7#WtI)dnE2`2amO+Wj=f<7zZQ<>>Ma9q++s3SRKe8vz#txn?ik!C7i@4ZNfuF@{^X3a>c$ZpF<-RR_ z*3??r_R2hbREMkkF<4d6>aS&THex#T-4Id{K6^HtD@W_jr0@$F(KB+o8P4ybh6|K< zf{^ZGDq@uPjus~tg&-||u=gPun{OJ4c=*>JZ@_q5-Rx zD9XhKtozNhU>iO=rqHFw#Q7e3Xhb|8azSQH2|oU8zA<7vo9Z|FFkc&y?4UEoO+slH zC?+}(f=dEyN1_Ni>c9j#>KPB1=*sYbOpumF9l?aVJ5;K%jC)xQTNXjir+6u5RMxG2 zq$pZ;u7N#Nss~lN{Hl{Az9q`kL6_hvh{1uPY)W1i2b~CLL{+KRIZ!x%Ju`wk!Pp;- z-rCI}?vd{ta9zwt?(ot65y_`>pWQXBo66^-HK0i8cKo`dV+fgENRSJ!+~hIqkOB2{ z{t-Tw2BfA8N1bax4Z10&O$Ujvm_L~JPI;VQ?yUe-yncOQ*JO7?d}UOsi(N~#o3*(1Kct?@wrpk_R5)Y_(*QD~>h2QOb}n5|2Fc2?=eSR6u9yQ;w({7pZiCbBHa^tzaYd}{u2A%Bki=4t-))HdLuZMV(Zc3zj;)NDus znvLXXJ30x-dRN)GKg{LWbd(PMG0#{-&NDOMd9;!2*!n1T&1h9DsPf&!FA|w5Huf0~ zonTIBrM%PY7c|&I)Ah~>Ec8yop1zaOO9>~sgfGkX?qaXRP^VDE0TOJNi~0h~+L|ZP zFU`Vvz&O1;OuclEMa~XyL$ZxZRjXHbge_}hwPV_9&pnL>M3`5!7W&v*4jYnI<2nL! z>~D?cr&POXWs7j@7(16htPY+C9+>P)1$-rolH8N%&Tv{7R1;$w*Ph~D*By#kv)mW& zx?EG&)#Yx^+IF<_HX%eq>QKJZu|Ku`*cbofjC-(QL58Py+?9QB3O z`CZ?n$pX6Gn^d24KnASyZ>QX=5k_$%6+bLYRzJV~cEDw)7%ga z-KgOHCrpm*;bsAtv?zjunjRc>_w)D18UrD+SxKJv@{IX$Lu;B_7Cwm&P1ZxP*2Al9n7iS!|2Pj#pzB@7Xm;pG!`5! zJ?D4EOKeLcSclcYF+inZHKr*n^cE%k6J??Y{B@Ly7k4a#W=|A{+{A7N-fV3Fjc&Z{ zx4vK>ZoDMq0q>7Yh}F&CmK~pQu_V!6>#MbCED}7A@|gjRalj{->;78)*8axjm>3!e!?d(J)az!pmS&a5xp$I zt~m|R08^Zahj^WxEpa{-kxJ5z5WnBWxo*!))mZ3LlRv@kY`-$2&a0DjABo-?R>32R zB9R+f|4fSrFO`9rX#t zPo_X~A5RjPZ`JS5#`^!vBdm6|OG?O?TM5&+Bvz`~K~X>NISJ`w%>BIBX2HZ++91zE z8_DYTQULefOuvvI>lT|GYz{y0X5bA}eOBt1EOTByOrFkcoS-3%=EasSzqP+ z%g4@zlZ8qp@XGlRr%k5r2%c30DW2?pvYsa-&%C#d?;xeW`SW$U<#Zt!o@|Se$fts< z^5LzlwUiM##1Y~m$zb-TRyoO6Obb^0wa|fQ%r@dpk=8(z-r3y;-WGO-ON|+op`bs0 zRwg8_-z#LoT3;`q6u1;!KP?>h+Nr6iUqKmcd9B&u+Kkn(m(Wz6(@lKd(Ux&-QzWS6trg@BPlmTppM7%k$=WNS zYRAM$b{Be*2Qd+`GTM#yNCwipo!fyyQUp`T>C11#5Y)xd`|<39Gr1}sEM}6i^NtBf zS95%#i4RN!)!_^geN=5Yo;tGLQ%cCcJQMxOrCG^vTk%OYh%SZS-ji1&1371xm%q~F zkd}k^A(ZxIVFLw|?C#nnW&}hI4%p*j-yT|~#NKzZW`#WN18rzl8b{bu0DCY`=Be$& zh1yKA%3pM^b4c9(Gd9o2gy~Csyh#gMa3iz={^LX}1Ql~Q@YSt!q)0=!=%ddsMzcP} z%qKXx%o+?xxzJi(V!z9omhKTQj^^VC>nRs$oLug?Jij%GW!TxAxk|wYwR#6;vgjt= zp;A@g{1QLfQUFcdt^g&g$1L^pKdfd`%w{8qqi&x#o1Q z4(kL1;z}D-0n!7jGB5Sh)9R$`7f072>YLf&yp4d`AT5~$qIO;Z^0r#(4D1wG#5`?8 zU2vz)mutc9uPiCc(BsLzL#5g7G@O_o%-*E3Opbcv@eRu>nI>^AYEowqJ4U2t39_ho z0-(vzpAj9)H3GBNbTSF`{VdaJ;igDsY6YUGzBZ1g3_N?y zk2z2>J9QLeQ|_TdtHH6*?j2#Y@jm=!IsX5mNFpX6xZqpO!N4X6NMuvXfN4H6IP-qx}99TXR&jD%4dgeHU+W|zkjss zvme;@Lu`dODrA{#rA27cGpMG@*sPy0>M?G@Pn+n=0-dT2)_Svhkjz)jN`$~?6O zQbFw=!l);A;?WsEa*2oF9Fe_|gUa_^29EU*!L9E;L>%R+SaRSGHwfw(D#NSOQtYY& z1b5b?vdzHkz3+M_lWj|F8d80;k#PNs)8S`4wqsk0G4{dNlgn7;B!V~kxm-;=t?I4QQ5Vl#mhs81|n>9S2sOyKI+$F^SP#T>q%s$M6XDz10ywU6A*)Xp|wPeBH5>5O>P=X zA>Gy1Ov}VVwlUqdmrNp`>Av^bAEHur86KM|qABY5&^tAuXLcirMcC>+I@!a4m;r^u zemSD`RKnPmfF+@X%?mbs;OJ{P|M7BMrp_A>x)8LH;+yIwzYn9;uFw0hy^t7s8@TUv(K&8LX+`e$u8c{uY|6=o0YucaRJnxI zN<2Oh&;wjS{}jnoiLmoXqKv`o*PXWpgFvVn$s7;zh)L~N$znd9rH0T?t%Ba~(-fIc z2v$n?43d25oZryv>GgFTG7C87aUpmaR0!rg_4ab*Vowo3-ju)8kY3H$)&5tk`gD3s zZ*mcB`Ay=!Nt)^ga%hr;(R^1}VWG_K*N3|l+fmmtIiVl!Zdl@vKE(~BHo4YI&&dRF zzPw%W5!@#GI#xCBYbp%TAaG@g8P2aVPdwTC=G)xxay&{w0tMuG$X~rq)*ayp*aTL9 zlqeCwvUqo!_NNTYp!Ljy(EY<6Kmgm{7_3oAew?92^+jPNJ7<=v}lVvW|?Rz>X z>kOo%>P((=+%-Zd3)>MR3k>zfr*NkFOB4cACiTuEDxqh+PBU|Iu?0zD{DuQ{?F5tK zRxiaZt;cm(d^PefOg)d9JJQ(oYYkiL&jz@HI$z`pIbXjJG^+dPts3j<+ba)GT21`{25$Lb_GT`-*;0M;$8-R8@;W3I49MZ4E$ zIE15vpTC{nvIn|P^a+LEz{Uz!lxsGatklc#bUm0MFgG`EKN==`elTN#2s;`3aWa#Y z4+Onh~VSe$} zVWhvv#?nMgdH#opaT5r7rS<|@D&E9!!US^VNq$CB}n3f0@P!N8A z#T>49eJfGI1*7CnI$HG}AD2=NfbkrDxlHGDY-wK0Gs>3G*&L014J1>WntlTlt$Y&5 zs8yoGY3T7iVxU|>)pfS`JO~GV zv2qJqc!uHj?&NBAl0?I*!#0AQ!tJB-z1eO+(&CGX%-8@-G~I_39@g*_Wwi6;td|?F zyinxxpL_>|g}1KAdH=|>AP{|52!cxJMyTTvU356om1*WI|mJ}5jD#?w*qgPNT_FEatGMKwJ?bc6^S7* zowuQ5K{=IqEZZs%{e{@6e>3;P9j#VXEM_?g13(`@6)mlfPY~8fwowp>zZQSwTN{iI z)1^5%VHUnU%b60|1KDX0HP82gt^vP|vouZiz*{jvVK6ZP46?i+f>w4$`oS$IN{g zlfq(7)!GQ+5>L+3nSLOwIB)B^F%q$TAmC61GVH~Zfv8EsU zk6yyQ(H%2Auem+94{JYHHgKp67F_s-IcFI}T?Lm?`YhB>TwqRWvh22Fq$V9253mjf zyE7~{8uh+TsnjQ4JVvM377%>X+19b>9=db;|k&a|iP4B?CQjUz8_Abud2b@pbT1+}1PcLDZCOnF9a>u+%S~dr}fc@e31{m&??}S`XzA6KLF-X5Wx3 zAXedOM%`ihEZlN)h`n*g!J#Sd2NSbM6keAh7wPg0_hiToPr(YEit-}+Sdh;BVTIEr zW)0ea*Wk_PLz%v!8Z#@fq78;U^B5%$QS&ZEjk#GKT*(GMEd(8d+&A?wyY>%v!-(Fk zDp(mme7NSToX*>+2rW-_E&HrL7h%54*#1xc26!mg@Uc7bWJ7aQH?TVW}jqwo{~Kd#iGtpZ)QNee~5Fx)r$Mcm_c9=<91X8l{6-@KVXjUAhRVeP!z zum7iK+)VsbO>qj~@)%$*#PK4GV)?3+9s0|BU3G7XfzzvBgy-T!+(`!&qyRW1Y>RbD zQj5d@2*v!@_VwSm>zVEb&`;hj;`X9i-=U_C2Zasc{lv-t_Qfb%3&15VfapP2*|9|R zMgqx46M2-h3!zpr^oCLr#qR~e*`L z`BiGa8cFe;072(f=_fHxvtaI#zO<%%38n3VY-Ui{ zx1i1lpqLM=$-~Ds*7~J}Cv$fLOMX?nv9Yy)(o35h<}ba42k)TQEO|g}E1%!?%j?iBZUwUNinwh8@DdL#N3db-;gA9(o_vJ2gumQg z+qS7m&nr(TALRsF5_(_d{{?BH$T@)A`;P3gt$1}j>BI*ZP_+ENQ2F)q0R=0B+~^HT zkrUJ2DE>;H|HYCe_Hc^B{0|qp7vZFlks)^TsX*D8=G>>t~T%$HXyCS)Q8#; z_4)Kbq)PKi&idQ#Aicl=f{D&jt3cgfbY;N4qntT(TlQdu24!AHqneRg#k6#(98&j5^UQE4~rpdZ%l zo1=%C$XSXp`?q8p*qbFbrO9DRfB+$oLEp?PCn1zOlN`-xtUkx#bLi}h4mFXHhK=iv z9g3Qn55J9#k1ehu`1N!Qp;j%rp4&b5(AIP2NUa~HHJfR|IKayTLMW8E7agrkf^$H6 z%cPUOG5*z_u~VRBQX6SZ5}$j^+1ZIW;*^;OiduFP88Po>s)$8`AXlA9k+Yc6DD}^^ zO|g=aYQH+D}O-?rYxJV657mK8Tz{z!pm!m6)k# z)^)CkA}>(T{%b9^H$g9I^+ywxj=J_!^gey(;2F5sJw;h`mJg)WePM&b)j{jL0-vxS zrP@o^arSyh-QuXMD4;V}y8Z`@Nx;UlMa3b3pK? zNS7rWHkO`ZjEXk@*tzWRMzt^Lf-~9$LO=zLs9uh2$YyF{!i!QY8Al@GAi4+EFQMI~ z2*{sh%eZv^36%W?+rioou9eZ~*5uu8 z6_`hD*^m_&T2CSFRcpkTyv#w;K8xOP=Naj5BAXg5u(Ku~FS&;-oBX43X8(!~*o7Q; zpf87~DlrWlyWVFh;KOY$(4mTkx!e+cZmr`me51+$lf z-aI>zaG!g_cgL+>9Zz^`L35P8Q--*dmr31d-O%PyFv^H%MKbXCd5z%k><7u+<5^~y z^29K#{Gb?@Kg|PikzJ#YLWbZS$)wW=2jb}W$`4mZSwGYI1@Pm16 z#$-e-dHGwbPddYu-fHgDc$>NsrKbB{GUhB{#HaQ$_2?~7P3y+xbvB~TR*f}Vt9cG% ze3idC!=wqXHjJ^43A{;DkkhlCe9Vtbqi)RU3NQksmC+J1&q!Dir!aWEq2q$?yd}Fa z(&@&))%+fvPj;Ylb9ZG|-bnmxqmCA*56PM|6x`ung%Db3g{AqaWGyx zeLH2lq5fdmkw`l8$N4tD?qEpLqm&ypWWmC9AVn~~22GEbUDP21S!VK%quDgOrnG8N$Ky5^? zlqB88pPLwwC2Zi!Cr#eOnW^TlHjx~WU_H(c_N z62@SYL34^>6mxH5K`U?{eQ7jHgHKwnE|y#y4AI^aa-{c2j-y*Iek&rEY=*+1BJKe> zBR-MIYohRo`op6?jX^noY>5-SpbI-?zyf{$BO~eN-0AFGn!6Dt8_{cT4TAz>0g-*N z{S(GAm=rBZORfFrh^z=}7itz=2|g{O!V`Nz$xm=H&CCGmvt4&#?Fc+poWp-fsmKj> zr|=vs8Em*5Xr8GRc%-{aYH3l=VY!X$dpu6VK2q3RQ2Ox+SNVh6=p6Id7a32->{B&F zoL09QE^n-?9d81Dw_5JNS$TlD;qs6V&wu`rjL;v&G?my2L(SeLS61Z?XcZXg)A?$f z-<%4++^I|#1fLw4H7*y8t%nGhqxbEZ{E+mQlTEo_;6qOv!b%Q9EQDo?L6AX){#Ka&7``@_$VszgOJDWfrWuUn?o#LEj z({BdqmXjF;(%aV?FZRG>XCHb#jGwt!5Lg+KfgT*E){dhYCL;6#x%Kb}6 zPTw;VXFwok8r8FSP45Ry>Z_2Zo3VtE}@@w;(!>U!Z_@hjyTTNkG^Ssrr+7= z12hJ=OJe1)VX&kZS`kp@s#st)vCFw^`O0}n(+g@Cs(L5b;-@yAp6(&({ACPZmU^Mu2_maL{fR47ph7k zDao3mmMKVtzd0~*4CU}E!d0SDT})i2Ra591rK0Ez#w$8z9By!ox5S9BGS{_zCh1>J zY4Tzh^X2i=0bwR!vz%1d>)YcxjM^gE0N1+DFy{95tWGP>J1X*rJNzn#vx5A?hJdJF z*6+&_>ZSg~*_F-uhWPfl<(I%6dY^K-8$ujnqwWk`9I04CCr?H`e{-hcohivdR@m3t z*O(<(Jsh)m^viK2eGiz+A3Po8!|{pdke-@pU#1aO(tF1^mF`1 zpEuU}2g}wl$;|r+Z093o|8TmVMILhKQb;8^v0-Z|P1jyr;dJ3q3# zP+Hlph{6KSB15-jIfG;h{chrq1v7~!9CNG;yvsJ@@p<$hjulFDn^BCv%S@4hbk>`l zREINIE(DZl+&&EgfrCh;1&qA{;cm>=bHyzOcnsXYEW@=1YQ{OW>2*=a3e{RsRMU5U z9+-@s)1hnfXn1X`m`;n1+6r~!lK?Hr5=YbY(%ik3@$u%#o{(;{>NKSrbDw9Q4A8Yw z{t6wCSISh!la(`-#$J?k?z>%-jnuj9W1*%;ywUDCVrX7F{shgVAcrTcOnIKCRSs${ zI5e`sV%-eJQ*E5*o;?yaZCJOI>T9DLDi^U|zbz|ABWtP~Jr~gy?-J$+2!$5SDi>$7 zjdm4mm5vd2)#BWvI-qpJBYOg=wM?3QqjC)#)=%Pv8SINDZ;cv*x4MRFgZC|q!s)Q& zcn0|{4ea&?Xm<<4RlKI>NXtxY+6nnelAu6;iP%r7(@nAhjaAAG&$=Zex#Q2q4dJUB zW2>$FM7%z?uji84^(;+3@5wb0Hyqd1-pS{E&Qm(@i+www>grfj*DsGP*^1jm-qdJe z3{Vq`!PT$?NmeFQ#j=c67>V-O>PpvDh|%K`@8`b74TxuCvQFNk0j&HoDI$%!tSizw z_630W-zr>ebt_eb%|tFI$-1M@Ell8THg3s9(`ukH!$#Y1?aY zVMeKWxumn0>GkfXP-9phc!}jKOUWT4LGGk8BN$$h;)qE#5a%55In`*f5rkC;P5Q3b zT`=p#_%C@eo!wnW32dZ3r4C$dyc)m-8@OT}N~WLOlUJF~#mKtitOcZH;E!)YZ>7ws zkdkS23(Q>FUNma0oGm9-;{R;)%+$ORC+P;R;c}Yx#DcmSD$vIdO_^|Gj1Aod#f3Q{ zoTixS!b<^S5{$tC5O-?$V9=L_opp}vj(J}T6A5{| zKjiy(mLkT(Oz^x8${t`@w_i?*&5z+p#^?uz?melE+il{gD}q(p9X!90CsHAYxZN^Kp)Qx<#ZFZ)~iSw&;qn#RF)<3k=t>jz!p4k*XPJfo3i3lMT4XJ#O9Y@yl$E#0rJe$xF3j^ zVUK8el`P7b%Z9g#PJF{aoOmz}5jPEJ_ey9)$=dM&uIz@1e)fFT`%2P->=I{2M1z*L zN+NIN3qfB%;HG2ne#~=t1k`=f_boQXxO1`cl@^tEZ$*8r0D;d)XsPLyoOe~4DTVa{ z9wpB!ocT#&@roGol!(5vd~pz)%1RZxzx3V>t%rmtjp@Y+_r#wxpDbGGd)AdLUk`F5 z0Z&i=Ev1Pcgof?g9*Nt;PP9l0#Ngy!y4acaPgu^gnfnS4`2L7p_eI{kD7O;517^+h ze_dlfoPS`hw>rXR)n`C5#;yQ4S9-7+ONmF`ep@0*IlI?#6tJnX!wjT{2k$Rm)*)p0OprCr+CSQ{G7k)~_Rm;ALt`^X|ZU%SF!SQ+Zjt;uA?5d1_wLImNN zX3fAp*Y;w`*?uS2Z6>3aD1$^j?+tgLxsbx6_JK*}%@p8I##g-evEY)cjwtl-I#Hd* zyrFzU*^7}Q8!ZD5pJQ^q#U%7J9j+{S3En;1S5hz1m@kLbj+^jC@t!K)Nbg{=Pk>fe z&Wl93u!Bc?8~X)tbIcYP^Gse<=nN#@n^W2^A)hJuOUKrMud-zL9}Y3LCQ?@&Z!@N!i1-s2k9)Ba_*#=W~Tg}ET)G)jf<;~hXSnt$pi)m6yxG>mD67UNcJd24DLSx4mZ`G|IyCnE$JHtYk zzHg6(cUC(Cq`G?V|3|abq1}+?+y?>rsJRS>OY2< zw^E)23BLLcgV@()a~7L0URq!8|Ev>%lT^U5_Nrq>PyNZ;c;@PIm~WY)J*(keD$%co z7S}W0z)R8+Ii~p**dtR#?bO#fqwCtTZcsEr^d>_TxpBpGCYA==o6qg5w=WM+(%K$n z&77?oG5)y?L`F+BH9IUvTlE)VZ9^`8fH?7lKyofd^1ha@&uUqY8)@HqQvlw*sG%55 zN7KM$nr=r*BbXxVYy8^a@%TE{YUr`OMa1Se5ojZDstm1uQOOoPj2?hfaQMVpBg;fA zc3WZL`95{cKWgf?DnAz%VFvW?!Do2v&Hv#jxw-_92kN(FJ*~%Kr+_IG27keE3YhWi z;pi`X+R@u&EY!URi(j5|ST4`2QJFmW9BQpEE^G%onlrh7ki8j!_C4o?ss8ZQvLf$qQ!_> z8gJUxjK{2Vb1M&t{;*tR&{r#QuPt2ebACE7T@WwWviJmxPAOCKQ5jIiyqKd=QQOZ5 z-M5|lM&1%gSjsw3r`UHEcmL(e)IM4jI0OjT!A5yA9ODi{>I*3#yV%4usF|1!fKt!> zq~=Z;$XISFu92Zz!A1WE!BbSz zdG|?Gxq#Lt09HrN#}k3aSwMe_GwV~-h+kbr5}A>ESOUSMhz7>KrN|7CvEdCk zE?u*qH0?b%M?$JFx>S*%-hOa>T)0Uws@T7gPi2 z+~C2xk$!fky2I$5$hMgxy!i~^JQyeSzr3Vdu5L8scoF;suDw7M0Zr`K_1HY zDfrWgaD_D7@}ts!Jv83vog!lK{s}1ySl!pWm>ZG<&(I!&bG%g`!`~Aq8y1n z&=H>9M{rt6&3hBX@;>hq?=PeJgdkrzmqNboV5>7x2rOiV)W+13nGqQ~3i+gzzA3sA z8*j7la_O|a34Cj0CAD(?_=T_d5{91R6R+29RdcraZPKWb2uXB*QzhrTUOGr8bz;oQ z`-Aph2W4*UGELq$7^jMchjHE0fgA<9wHeQnG3Q3zUy@q@{x~g338&X$RKoOqld-(Q zDI06jsyt=eGj3Xs(ucoMX#c2++h)X-O++S+q;0`mV!}@yvPq+7dswDmE8!0xEQR+L zzjmjiCr~B=#YBvXf$c?3Q70>v?p+KaSY}>Z{Rn&fY(6vGSj=%;^;t-_j78uJxu}W$ z75O1MBcjN1FVAW}UAEv_6V6d(SUKvX`PisbWdrscS^jYOqvt4tBEB_Z=EM~v1XL0K+(pQ-!!U>;wV5B^y zJoR4Jd59eLkd&w!?_GOrdxXscyrzcTZUb$ivvbJGIsXjGAg2rYsdG>*+pSJTfonw3 zweMaW9d(iS={He~6!#|42YO{ut225qXCF*num->CtlTg?5B}A!g5;oHo+v72U#ypS z9aG`UQ-`c9o3@wB|Ivm>5#VQ>nzql9(Np(1{sjie#1X(kPc8VMkDgW~5?2E>i8JM# z4f#YqUS_IYXdt>9T5L-@UX_g;aNY51P^2Vk)el&7-;AamAO*iEo5%#w5iJoj8P3t4 zpW7XrGU-(spAQ@N8)3W^j@A=j`JW0gr=3reodNo`KKn_gs&qHopV@N$0|&d zC%iSSjd`uN<7`@Y0^b+RZ6%F+mTkav%lYini`$%DpJAd1Noy=BR47%FEtF0^D^of) z^I}=g#FKe;GpV6Y7Rma#^Swq2jgJ(GTrbb-$4FbA&CYJ>Ig`D}ung8%ZXQR8z}giD zZW}f3n8teYg>|WmnX>AbD5&LcYRw(CqH2?mp6Pco2%Lxx%D<(Y`iDdL>M|-)A|8N9 z8u2az@Sk#{Wf|}I{H`!XktI%8mMr43ZHn5t{8w-oLwbdv3zm& z7uZOAJb=rvXm&n)gst!(ASK9$6mf0UeY1yRoZr><>FTc8-wAmB(K{9zplkoPxOqa| ztCTnQ8SVS8|Ev)G4Kw-gyZ>Co|Ci@#yVIjwE;c_20tG?hQ_7M&$E=6*QwCo8Sht`} zOCfyDwR)z3H$Z6nI^MhFBMPD){zAW!%Dwvf=k=Aw-R@*99cxgrPK9=KLH5r|N9L_7 z{6R9;qKY$&;v}W@0tExSvfL}V$}-8z2}b;k_@m9oUBZYa@B#eB({a9S_i27hOrPrM zu`pExm&j>wEE28h5X!%d2ja8Xpjuhhnd3I`J7|VHds_t&wT!Tywz`g- zwE+rjYYS{vj8Bi0X$aReUqNm~PTER}mczBJ9@OO2j6NveY*4;fLGvQGYJ1{fT`>bL99ViCJ$yzo+$A%iWZ$0_i zy;AN)6;X}`Vk%aoUAQ9sfx4glx`A^e<;~vN?o03Id<8HZO;3hPt^)V$prb30?c%2W zwZ#EQqKOx4Lr40I3J)v)^1;SV9nQG|dn16QuUW(gMH(R+pCnjNzY_m5-!kKCv?}ro zUOdLromGmpo`AX29Wrgnq_hr)K(nbnj_AjBggIO7h;$`$d9Ckx4@zKjxNw6kaD&unKIv*y1X_9!6_d7a^QH z<37{t$e@1$IN8odO7&)}2?gH)rFQ zLXXL>qDf;%AA;W>xBhTq%~lENvNPEX(CiLTy1XGJA>RtSCA)6dr(OjF5S$pj6qj*j zU37<385&e}_ply?*g6E`BfTQ=^QF*ko&0J;s9Uo1opOIGO{!Q|cphHUKQTZts%(>T zijn}I#??F5i$kzu%6%H{t{S`&4UcIPPp3Ez0fQ!B_nrjSF~jeM602I7WB}pSl3_2B zF(;EV)id5XOd{$vM^(b0Efuwir8s84*W}MGr-zk>8Nz`?0n0$tC+u^+t%(d;`YJzh zFsAJpcwf_b_gy4p(8PBUKU9*i-D~N#tPF*(|D+i-ocpLIyG8C=);PH?{1(j5CG=n1#j?J4d+cA# zFOaa18+#~6Mfb!nMdM}d3V8|0IQamRt*LcA*HB;%!(AveQ>xQvQ&OHl&oB=AsKYVKi#D@Y|I>-l@x%QzPaHYE0M>PeB3mPgy zUDZ}C+AId*k2UI5Q8#IB09gXYKfTWlATx^JgA1d>h{GjmFUvmo9}di(NnX$Ot4+Lw zPXY>YJuP(}lvx26d+3SHE!j}rPdEN%!A$QZ;t8V;W2T!|GnqzYIaV=f7w8^_OnSWH zMc37>`hkO(=MYi6P{&J$?*rQK~BK$jFF9 zu@I5BTpW98)VbLYSGFJLAKlpeD*?^^gNHmT-Avw66x!HJH|}o8_{@37juoxqawyMo z0*ADBwby2CO7hBP>BF))^cQorkD610`V*c8lc>&QqUWr3%4Z7sQ%m1q$Rr=cMgBB> zNokY1nR7++Uc}i~&t2X^9Ra+`*i}T~pb3QIrJuQPO_pKbICMeyNrM|QYs|QIR6iO?-ke7w!MEVf&~kTAR;0tO=_e|4T>Ti>77Uoz4sOnQ32^C z^dPN ze?M}A+OZk;TfbC9s!%xrSS>E{&A|QViBqWN=jn2WyQ!B&4CZ~jU6*}vTl$rA)-w3r zpXes>LQZffj+Z6!clw)|USjev6-bAhP2*YPTEFMVTnk8-L0b_l(H^pPelEOC!R^+m zGE}VZXZqMu{~)|TMeMq+W?Lle+y+TwIQ!)M6&Y#v-k@a$xg6^DSZIB@Gy^R;PPkvD zQ=6}*AwQ0K%1obB+6P}zz^bf-Pd93+6iW7%k*W0GPR(~Kz~h#zR3p7Q1>7o zerEp5W`YyR8Gry;3wXYc=fVgueHZSIQ;*?XsX~+|(*xRR|8qT0>fkHEipxb4o@IPF zPk-vyov*I-fuV0<4r;o_8EZQ+=bx9$N`+T>+GgEgZ-x)QU)!cWYv>=paP97i^$Of821pHL^I}YFB*IG!r-Q5nRMk!Ki99AV>2hFtsZCo!r zwnt|VsT?&WUha3z)S7&o1pF{&OnNh#5rsALA=$kEQpDQ17$nWba8se~YP68E7U<{U z^1Eby@FYBnX9)hxU&EhoZ6WVjlPrk0eG2E4)59BO!~zEBKB@34(Rp~?zAZ!tIsNxc zwSsu5FA_EBOI8e1W;m;EZ`@|Q254H~bcQ7OC*MSjRRO=EFZZzU{&CrWtd-z)zaJ)` zG26mxaEUon0smbq*hDQNg|gA{t$!0ZZL@2@$@#NboZhJ*wTnik1W@?`iIyF3lrfD=-KvvFd6_JI>Rqor26E{If{bbh-Yb&}|C2Z!_4RF>hEMuE9=Fx2RhwCKWpd`WN?_7?Ldp}nZ!8XVJbbaEu zpH3leY|fKEr^XcF{X?kCAxp!}4Tr`3lv*jxv*v?ol<;+6N(Exc+~rBP=mj_bksR}7 z@W0rHtji$f=&tDegO2uiC+&Rd8@wFh<$78}-W?c7NQ8<0P|@m@g7JCSJ!S6%qMIx2 zgfw1FH9+6g4sB-V?NOre1^Ks5Ue{=`1}j2P&RUuW`DMI?k3m@>g2T(R9#P zvT*B5cN6sY>wrn^L(-#uXb!cqzOot=n6z$`>IL&P-dIG|2*AIZ9Jk{Q5K&h;iZ~R4 zy9%|Q_jjbdZI*hf)_tt%;l1x{Wg-0Btg3$SFm*weo6h|6o4HP*bBd6Zmb#VEvAcnH;r|cJ$aofijY5*-Y2VD^?hep zb_8S>g<*#l4Rwqa4R}#Co#H3A8l$u3&R_Nm%rp$2>6Vx+u5qs%ZzN96)wRb_?#ZOK z;GgKO@gDo3OT*T=k^7yj5-7j{B{(2$dm=>;(6yKhL^8#3m*gvFRSxjhHs<6Hm3)cg zE6}br9~gx3ZMXs0qDplf8NX#k zvcN#^r8py!)182Cw)a>1SoW*L%!3n4MF%O+4BnMCDWsuniS!NU%+j;ynEUD zMMG|wwL~sXnfqa#?n$lQ@bFz2K&s;MQbrC#dPEs*jPQ+^bvLyI*{pdH_N9sEm-lCm zz+9w9)D+ZJ&BV8diOPJ>9v_1zqpJ`wjqptZoOlEd=%qA0-S7y&PdFpIyjJ4;<)U8v zBNwAFcwNOEu)Q26w@wF9o;+L2{I0GSUsjMMT@9|k%mRmou#trwzE1f$y}c~^Ode?U z576ULfh04GX@_1q+k-PRmwLalU#TkaIw`d+_p+N^+v&d@T?ew?eu!UA&o3*+LTJ4% z=R~dUB8%7GZl>Q4;jx&U7Tk6}ttVhXy1rL%IWb+=Bb|{)E9>iS`)keL;MXc5;*7vP z)gisX@yOk(95TH)O?$GxpP17Vw(6kIq`8@ET>_lYXsCCua1O-Of_P_mKQV`&atdm`s z$g{b{A1aKo94;)JP>9i+_5QLb#-!-F@$}kuG}dyB2;b}Rq__T(jO4ccNq{2k6h_?P zyOeypHsrmSJH}1uvJbj2oWV`V>yK7_V|hwMhA~ zSu!6%FCbL1AJne*ERVK`Wu8l2x-Nc_+WZOTY4@s?s=}JwKeC4M0Yk{l2mEZc=Hsyn zfnh;y->$gV!6#aZb0Xa2safx(0xY=B3hLJ@J-El5$D45R1ywo^OY;pAp;?78uy^8n zZx>}@7Bf%{r|JBpWopCiM}skqK1&cHp$2F9{?EAX=owd3kSy)wJ@$7J~c*es%O=|Ge z?4sz|7o*0qa`TC2q)`lEZUbAT8^Wfr9}wO!Y(2vtuF1gL zlMzdv2e~}IQ?rO}9!NX--CZP2`gr=L-(2NJSHbKuoqhWknWGFD9NY--CR~fYZ$3-` zN$4G=o+bHWJGSIOtTT?UAE&T8ipZ{&f*e-N!8D^@WO@9~S4YZl%__J{4S`}BMa+=j zm?`}7`xC{tj|*4Pp?a@}GbcHUW^4~;R=BB@XsL{#M2;ZGWwR=vnfy@ldE5QG*uA`* zv6-Uk3s2^r_90=^eq$BZUMD+MZ*u9?e183+6ynvY*8=ik9j4;2fvsFOAGnvRzP-!? zH9J52L0I=!BcN^o0AdV1bpQpgI-wrBS?4s$x+O*}_QcuO*HEwlDSYs)4rJv%M(FW1 z(jRz-?(gS0Y3TPq)+Ww)P~V5?)ry1xg%nXO0{K-OxIy=^h%?(nED$@9mgM8Aek_C_ zL_8`5ipH9uwHwFtPWxXUx(+nk_Vd_?x;#_z6#14rURsl zcXE;`k1P>+z4VD|2Zh2~wcF|a`u@KUkA=V=VmI-P*JwgRR6U4yBCF>U2p>_f=xrdQ z&)p(`o_4bx5ux}yLRN59)hC|&OOfldw=2rzIV`|XF1NPiA%_p;9QQEw4uVW8o%{Ih zP0PNLP!V|9zUbSgSM+nEZZBA%^Z8k*cj8@&IQ(MEEu8GjqaEnSmz`;KvCy|To*dV+yJ-rGUg1Fm5n|ZZaN4mu_nWQ9Qt8R>Al-qI&=t4+? zvmL$m9uP}l$}y2sk8)YpvyZGN*?*GwUjLWz7_|Os;p0h=(_@Cm@wHtPVM_tUf#{$1 zj5~D!_n8t9mZTQopD(t!e}~+J`-ecl?aFK9_bS&#i=<{5^k-~^tc1@DTGX#joKlwZ zgz`kMtIy72#@yO}QfR6q_jTfgZMSg9Sk}J4h;MbCf{)rC^)*V}?eA(}le1Kva72+G zY*m3x0plo0+jNkM8*VG~N(DPGgU}3dG==N?by)N?lyxkq#DnjX;Zni;&eZM*Q|ijT zKf@8_3mylAm+u6OZ>1B<2)Z4x$Q9tZuNICq)YYT&JK-R^l-6v2z8G}V>{+(_JkuDw zn&Er;`vfqoQJ`#!ND;k@T?yimLKxz&U3RltcU#D>H|(y6tUSbJq8fg>m#gJf_FFIs zOMFKWBO|cb#M5bKDHykokil?<2l7{>%oEOi?`Z6iXh5itp3G5VWP4YC(1Yc@{hhse zzN%R@zIHuR45xAL_ALL2qV%(VA5nk&*ZDU_0c2U)^UUnfu$>$VV#)gjzY5+1P8>zb z?X^2xH9$Iy4zc0b$EoQL%H0Bhplu9Q96M!-X8;oim||Xil{z&e2CwfwwX79+_zy`c zn=c_th0hZHQNj{?Duu+{viDafUFX7uZM|dAJ77h}PZkJs%$IL&yR!3^O>(z9_^f&i z%J7~#r%=R?+s=5c51w~2(yrgE^d3nxb?ALg@pZaaw;mQ7`m=$4L$Ii}9Qi<#@d#bk zw?(l9XFcyo3h5k6sOV zXg?547A@A7aXF=~jH3ThjVV8DusiJo*uioC2wxg+e;BzS};lV&js`+&<86IdP8(14+;nE_~)DDQ$C_~*)oNEC-2+CH_eH37dVB{P&Ai|9JFTgE5J3rakByuTE- z)z~F(Ql;zsZS;)OF5l|`U!_~o;N}L(I&|L<3qFln7NBqsul8VTN)M8YD!iLX?+}nJ zewihwa0=>_wPusrNU>fIpCCMxnib9kx36eNNHPHGNF|-DNvAnu#{#LRmK#O&_VjCc z^6ClWB0W(w(l^?T8&?zSvbJ3rjzJgn#*DQrP-CrdlG&N#EM$IMDzDG`pOv{E3yc?v z3IFHJIi3?i z8BID;Dr{U96lGIZ()N$})eIjfw*EeKp)%D^@dljS&LHYHw~!mmJS}+t`uxR?K8w_) zY3acvlcGk^Y2njxZbdslg2|kG%^TqvKC}f!mETWYPn@aL7AzvL!hz6*!egamXP9>1 zX4ziR#q?q2lT;g}#t1-PA^N5Kh3FV(Pa*w1$%}Z%=#3npSKRM)YzG?vIcMkmU(J2_ zq?@b*-lpz)JT{G)W_8#$#q(4HVZY&+`xNELWan9DT&uUgqXCJ6K~QrL_{`Fgks@T{ zGobqJFjPtQ=9;@HUFNQfcga?K$f6g>`2fQ{jRBIivrs{Ksi_%RJJNEr3uGk}VfxM& z|FUQR$Q;pI9w&=!Ke2#?e!8nL#?TX=^Jx;W>{N@5afuTx!V1GZL0Rv`SX!Mn1gBjn zbuChTmfW;zP#i|<9&xoEEG2IdMDWPGFlU{ldIF^zC+psCl)%gP;#j}UxPhP10@9Ly z#XnkNN-qP!+Ula!QXro5u5b`77OS;ifr8^8)*XMAOP|w$~_FuqpWZj z#`-&F_IZ%o(K@PX_Xr{obM0q?Y&&Xd7d%i<_A?(Ug@0gLA+xJEFX9Wj8y3Fa@Ln1e272?+=)ROm> zzJ#63GD>A({QZG;0wrOR)AL{4OVbCSZr3#_%W6}x(4Q2vkmu}tMmZN_+oWYtXhQFp z5hn`ELd*!U+!47_Q3k{*eNBD5@L`I%pk@*`W`CdbgY{)SZq`m5PlsAn^4)lr2DO4_ zacEL?3IQrFao>0D1ptqV7=k8A$R*Tk% zMS;k|r0tRfOK=>K9JK82YU$2A-&0DG+?2SlcTS5$kEcRkm!uX<{sPfPBM}_wif1Z< zgkBGZx|e0&h)L7^{O1#ToOMG*>oW5?#p&x0n2M**Zd0)xswjE^&m~0|54tL1rn4LZ zdg?#E-vvT+z{5wK3!SIo93z?$MD$=nIml$?TxEeKG>Nx|rAIB$yrD< zw%oflkfAeX6tD8|_iN;!MAI0i0Mb$smpK8xXq$5GWg7o4rhII1r1iCTsgMd5MHTK* z&v`Ne#;t>!JhovxlU0p9tpj$eTinaQ{o$D@hsjefd6*hM>L^oMJ4QPUZ5q2VyV*V+ zP4PaHmDF{+$WE7QI_khYIg1`%&be5}ud&m39!njxY42d`3_x|>zWDuQzTgVT90YW+ zj{ip1V^{4^_nGAQ;#=RxM6G6D4DwSl&S~t7(zC#yWO2>Wd}l&W9diiNv-NSIpMDfs z%`!8@KEbYMYiOi;FxJ#!W8`(-H(vZ|D#N~7H4xd}h$wSDRe zBpU8GgX*-9{hwLYiWEhNAww@EYcqkdPhy2*36u(_Rn1!zVv2MGwr#4w-hhu$M{k6B zY&FwU70|)CLuP)TfJ-Q#Z!C5DWEo+5=9=2idxOPn1(qoe{K~PM17KHQCm2jUXUTDc za}WBP;RR!~t!ujT1I|U*F%xT(-N5)4BFxxyAmxtW4^L^aDjNT2u=iyMxKMJQQoN7@ z{8(FJa&+d-K74Xpoe53de^HW$f7?kB7FCzkCE%52*c|7nq(DZNUO}xAWOWfQ)}#ZX zHQqs4V=k{f)W~A@H`51Or#KosygTr2nByaGqBuwwG(j0Q-LUPAfd$w12J+(lB?bJV zehxQyW>hfr1tmK>)2)Ute`z?@Qxw!2Ng!8cGZGvFKg*522jrqm&X_m$=;kvYvFb@?ITi7K8nQ>j=}`?frZs!06!%};+hjs zK@yt6qbTTnx9+1xF^WlzZM4V{i{0? zdyTQzBywhRLZsTmwGELj#~2BX5D>!G?+A$(ah5tNb)s8w7D7(DAU;X6x=IVE?2V+n z&6NIF*mNidbs&{&TVg~7>l|$dQbP3&3%KnQO+S}b_^Z*@9wN&Ej>{bgEq7dqb{v1c z>X)lLc970AbXUbzBLPb&!F$$_Fz_VNsX@B83 zfBg1L1`k05I4G%?mFJSfqLBuFe^ zgh-^8aBBymj|2~$Lc3gaGSm#Mmgdvd;WdB~!Ou#rr|?*` zQH=Yf&QAZ*gpS`T3HZEQxZ;I(PjcOkCEs+4)q9f?GzM{nyc*w_- z_nlf7QERbP!t|Fe2I^5|68HUNENMT$Qy;r0dr0JW1>(1}Z-IY1G&TNJ_72H|Wle zG<};!AOQ&xU^-omY+YsypwH<6x|* zFw_|rnTG<+Gc}u`$!w51B6Z2Z>;u#5H7J;kY_Koq)>zw#j1o0L#54=<{Zu86F=KGH zgNj%@zfGe+);oMkQSOG<#>x54xAZx#K>Zwz7-^}qz!144!5+`Uj#a*g=UOJ%Wi4~{ zuvD*)4pt8BGh8_~!*=+jwerPElfGV|x}j#{67(UCx`qO?=Inl~<4;k-8t=MlI^jH%tNtOI}ZBotB=`u%1(Bz}xZq>g1QD!09uarru&Q z>Wwi)w_shu`{Ug6g&Tl7`KZYD$CG>6G=8dbjceIlOCb*3_pTWeA%{OKhU@n|Y#p^@ z=C~8O53q70Y|ZU%#07?vLZ4==$`4hdu!?~}*l-DefY?Y5#H!2?9hN0*13Ki|H}7;- zD}x#TCAHP7dWDu?ljxB3pt6_@*JPa+s=6`{{7OX+h`<4XV>&R87aF!`W)(4(N^rju z!eg)E!-otfaND;&(B!Opn+Jx{lBX^rBIt)|ZQ+qUKumE1QML_5n5z{(lZ{{cNwi!L=yN!JzmJkAN|C}_I0+NZ7G(A(BjkPYD zO&(GKuhJlJB2N6Ap$#G-1!pY->@yQ`gW4^8zagt(#Z*?^l)q|&{1YVPE zqDo#-KVQ+@^bBW#%sosr#RDzz5}_rdAJjQw<#pW9Rq0!`7DR=w(;6R9Ye-f9Mk`vV zt2+-42HX_XBfs2H)z&}9qM1@&u~R#_F}2ecKUVN-OUKeFScf3OCi;85GLs{s5!gd8>{Q__+Fr%{A1LiqB^BCua5jH=P%} zUCAF#Ied%BjFj5X;qq_9_|TD53%?mYUS z;Pc%V`F)zvMdXGRy_VbrHv$@l~niZ^e75)@62S_6)85c9#baZhu|uWX=Td&RGz>QK!`dW39s; zO?Q#^X>vSAfbJfzVo`w>X_uM?#+h1&r(k!6ogWngrPUUsWn1mX$3a%p+?Z&mBUQ^n z(|xFF7m(u>4#+1yOk`a@_egYbSKBQ0^h#qLf>dM|8P9;iyI_aapvx%S0z^RM+q7|_<7)O?tl9Ce5_;#}FMIQUk> z6#-OL==ZQ_{<+(4Q>q>8iH2x|tm~5+SdR|UxYG7WXPg4pS9Pe=vwYI$B;i`&$~5#5 z5ueJ|F^eA!o&rNBSQLwM97E%Tt3caT-K<5LLB3Te z2d22?5^GeP_}Vstxh-YI1^bR6wM_`Dh{?YleZB zvSyun@1<9ewX{{=dTR{~foB|RASPHve6Vl&)$op{kAe)RL zfpPnhs+;$+$?mVkzSvMO_F10fjCNL1C2u@s2Ze-An?W*@`sb^pB%=F9qratM1eu z(Vle(?hp_w_0e5*qo6dcuW8^5jS+jmHfL@SVz`lbwmvCom{vXFk|Q8WHWtQt|G;?? zM0CddJ}zGVZ7_@-i}a~L+&-WFRq4jFjH1##2bQe;U&d%n3(mXbGH9J5v$vIWmNey? zT(@=YaxTuXE4kMt1r?t47BeCEAFb6M>EfcvTsE(xv~r=c=w4tSd|cD@yp`w;$(=Xn zIUC#$m>DgGfF!|pAA|W{3?p7CwoH<)GcZK28}y?JcrTlrtt}YwTmCk@^xIH-JZ38b z8kuhnUY)EK1k9>_(TvI+24v~oG9d~Uy>`-I{~L+9m3#$gL{f7<+9aJtB9%sPj>csB z+7hF@eZqKq3FPn20h_W0L6=T@8;AA^woIF0Y&^Nccx0cyn%D+n(WI2MGWq0v%3LJr z+G)D0Hq&FA%|UZeOHWr(1LgHyzpID8?lz&dW$acQt(n15SoDWKdI5kg2jDTlT4xJ} zqT2hHActr#cU#JUYds0PyfW@FWEu61SFdo@zym5|H}g<}t)p(+({8>uFv3)MAKa)Y zGW;uq1It98V+3n@ckG%{XeGW~wJnv-<4}9#dS-yQOr)SXW${~2c5uu}G+BikKkwnC{~<2HB93LUF;_>9+I%l|8%W4~Hk#+N%~~ z^xxkSKvW|ZUQ4}sPtBveV9%Z~RMeOz< zXnmD92da9o;rAu^a)U*D`Ktwur#sno)+I-pzicQQ6gDWx7(Y->@n^%j_yMwdR!r+* zupk5`x4qCq@Ok@- zI{^mQ0eiVmgE~G+w3mE+08?fXf`21+&;s8ke2x5_m~U7e`f;qH4biU1PNMSGH?CkV zOc_AqC3|=2a?VTd#J_?OedAvPf6OdjGH|3>1nk0eJX)w%T&RqceP8h==&kCy+#;~% zka$?FdYz4wfOt~yuoUHIQD8V%A>uq`7p?;j`gg+UGSG>WQ$Oi9`R{-JV=*oT@V+X} zatox z|NFWB8V%q7jqblD-~T4_UpUDBdv^ZBBfSnqwCl`+i&*~rgMa$Rlc?nzc&E+Na}kL$$}++{{vS^?~P2SpCu zP70x&FB^v=Dr7_b_G3d(t^Re3~jUnTW_ydxO{!P=? z^y{|+MZ0@WpJx`N*xX|#+ps0g? zB}z)Y!FcwO0P~eDRVEw#N~ zrWwO#cJ07l&qi?>hK)pY$MM%E*wtXH;$!P-ox8`?nW?Tz!m5UUe*ts5Gzy>WP&;pZ z(jDW=+ODx~6Rq;~S&}UN_XrP�)OJ%dwZ8CKmec^u6&_{G_|;P?r`Rc2s~@QB11_ zJGingDx@Aa1a^ByFgSO(NSN+dX%)Gq7vOWqFZ6%SP=AIUDI0``ufYKev!owSnv7%gk>SAFu+K%YOyF{9qg_^tsS-nUVJF zydA=~c0`&PW5XEjL;>6R>Y$&OOEg%Ig=u}R;ASg7Z&aGMsDA1Hx55TxiYFb<;lCKzR+R|X9@Lc|#bM&|I48 z-6j^iBqrCo#?AOuX8lP#<4fu$N}YOm@e^Ezh^gb1cFL9WdBg5(noOc*cv*79_2Jys zL6g;BHJ&7X-PYlt>BUwOZ*$SdA|tX%0)3Jnf-;>7QdS1hS=Ppn`12R}T9%jA9eUDi zLb;2)Ps%8{?MzH-GAwM&v704WmL@i5JA+a6`Qr)YUuFuPF?~q^*$d(mvgNGglGpk##p8~ z8k@$7=~j6u-_bEhh13r>9HuLa^rJ)w;z9Y;uf3tITRvq3&N5@#gXNHl98JSkNIjrAE`0~Y}25{UR2wmA$f0t0?9s6Wh^@z>6 z&Pk(Vv&Jp2_?Fs#K0oBFv|AIat@)H=JQ}dVIS!MFs~u$yJ+UHlmJS$YO?Ft@EGo`W zsDOO4k3UvDQ#%>YSZum~b1>if{PzsC$3a)X%2M8(b3&7nA6gwW$!>_)7+nmxSE8mw zNxAiT+i90GA>L||gW`!GdeWtPx37#nzxmc|;KEZWOFO9t!Y=iv1(YYhR;|?+l(=2d zLY{O(>H0I@gzcs$E36G_x5s)PJFTNA-6}Yj#^r(uk)F)*V(x~vPzPYqqU>peN7)m> zM+J7gc?GWXZ4=g}+tWMW7O++>!$=1klyxU^&pFniuN<^d+&2ux36WQyO<$RU_Rvza z%dghN;TIkrFV~{i9HQxI0rs4e?ca?cMsA)}F@zLvjnD*@9QQ9>3av51O} z3#zX zRbl0i!Aw9f&?iE3Ek@X^s6l7(WM%$|kkMBsyJ`ByU-m0sAl_XpCk--3-KD9WoklJ{ z1DM(!wYW|Fs!z`wWkSmK3i4akcto(Xu0v;-djm59RXYN8X=c!Zh*O@fz;{eK*chzm zbkX^CBFex81*__~ySp%+6Si?TEM(g5cBIK@vv`$uPojqyF7c@O)xSdee?F`l!q-*O zeduLE@j8)a18FPnomwOL3z{P;6*mrUuc%rBq(q&|O~$GVI(ex_>8=W)m}$;&UDeC$ z%&11ESu6hl=GqU#3oHTJ<-L=mn=TC`GcUH^k2b!%%*?9Xe5b^t5R!F^qP*ljG_K*K zG1gXM-}(kP^l#%L|G5JUe;^=dre&5;*s0?(+{zA?&}oEgn(Oy(8cedyeb6%osN5U&iyoTW8l+$& zbg4nvRf$(2kP^Fq-kRmJd~J{VF?o}b!H zqQ@qI>y`KulSSV68gT(Qpvss&4jI?KU8WOxveLDa6?aXK=Dv1sLuH7Sl_d?FUQ}YH zM} z6%iB%g&Yl}!sX#Zk$|N8VPv7w)}Q&oM-^_(S_)XRu{*2@kh&BTW(@4-vR)h4Rrx^5@FyXb49XN7x%P5>99)nn47YZTZ{xgK!c zoC@L#vxg_lI%HjyDe)Zcl^*L4Wbp>uj`MGSre-R>EogF|F8r<3t7ezYb4%9{ZMWakTU+^FahxHdRJc3= z%Uuf&nc_qC#>{b_DHkNy4c*~jT+3x4>s6cnd zdGleULQJ$Zkusb&6FO^quPV-&&%_jJaL?90blyIDUA?8Yko*cTW&V$Q^v@N+mHu9b zLSV(go1LUnT~$2=?pRQT4;j;~wW}eMW^zJwqbw55Z>PJVcKn)OeH^!~XkxSG@K4iX z^}bk|V&+UnzIjcCkq>7=MZ-(xC{!YUb-FG|9Ojil zUXz-G_d*zH+F8}ecirl$SQGdUFP$F?uTq{7rT+swD|X(Yii>54dEPibcxwfaqqO!6 zugnFoS@TfWXU4#ne_iFXb+$s8lfwa?7>|f2&!zIh5zh%EyT_@;w*;Q9xmzZF9v*8? zni}b?ZSJfm-s69s=0iqhM=)5CWl33`@Kyo5RqIk}QX*s=>eLfZ$8NhKJeT4|gdx?~557=uoFL)L_6a9-mQut7BwX>h)Kf z+e+q_rS=@<%dO=V`76`irI*$#VIBYoyP&j`>=~_<%Qm;Bop&j5cUenMX3S^pk}k6=PF{31hNQcUj*C6l6W~7WGJkO6T>m^&$)}w^^o(txAUyJ0zDsJ1 zg8t`E(J*PT4et*g4z}$hrRL~Fj;(Tzsyjtl*w~^sBlA2|h;UN7iPYK`YD|z)XGdwg_&cy$!Ly5;>xX@DSy) z56Y8%EtX5n+w1#hu>D7J5BBk*5*^q|*A=&xuNcp{IcrTVuK)bb8pL@RDbu&w^G4_( z3PE=8t^^h}c>Sr}1Ia0^y$u#tgSU}v2J|||Qk;%tGE5v^y!!6HKWD`K7}TJjF}k8+ zQ;C^-zzH<&;xMp|Z|7zv61XzTFBjv5mczAkM1q5VfM@sD9TO6vV0R_=L3!U23C86Us8-Rm5D6BJe)@mae$N5BORth2zNS=D(Z+ch*)nHrx^H`=u|@=)1r z+r~G^Kaf8EW^LEht}05P^r&;`KSso!_I(M#;B_JH(E;br`PGga$*A~6!2)uP*6PJl zVfXVE8pA9%_2l`{+j%8UElSdKpMGkRuTN)F%_u0Z#$JH?joFuPO2%uQV@a4|=T^@2 zO{VbB9xPq#UjEcM>cTotspM5e*YIVE#zgX1&Cz$IukC?QOsSi`CZ1ihE~e`N+v2BU z=Yj;_cx9c?q!0&-;~X=+T7T6E&eO%C(aC0kVjSaT8qb)IvD=HH0(4=b)Z8Pd9=~?; zS&=*dtvXfFw1*k@~9{O z=0K^*q|HG$)hIPvulqaf8Ex03Jl!Wx>=}>4Zfg;XhgyVBMQ>*?LDy4Fnzy=Jjvqm^ zXMz^V>*HH-`S$d0B*SdY+BUH!@B>5_(8_>Pa%$42syM*GhI?l0C= zT6ZHmlX$kO=B|9_-eAnWsOc7##8{3^Kw07og`8OFs%ivfMmz5|FKm4EAS1gF>A z6&g(zd1_B-2y(A<^V4`9$i%p&3yX)$3_DJ`G89}j8!WFe$$HXP+moO1=`)l24%s&H z_x7<^f2o$a1-839@f~p1SvgWawaA)ZK_oag08seCxTUsi!>uVEPA7Q2)ofM%V#I<- z5){g*T-!}78|Y6iM_fFkAH3pg>xSRuEV0UT$bCjDB4qG7l{~5Q5S3*`NUuoyH}0B` zSjojnd$0$FTfF6Pg5ELFj7q;u$C@Ejkf+AYI(W=naF>*Ss|FIHt^O@(ZFo=d^7?@t zGG6>z!-~9A!!QquKe@z7;(rJucQ z)%u3+tbFJISEh9v8DJo!fA{e}q6{+elm(!YSkKF#?owuX)UR)FBZL-FnD^4DK= znrdeclik)M5z{%EGCkdl{N?f@h_06p0J!0MHBh@AMna-dhpK(6GzRdaaOzeXwPKE6 zDy+J2(Wz_MO6VPLv#eA*u+_GU?QLB4I`|&U9?iJk`1wgyPEMVQevGzRXUIy@Rk<$In$<=|X_PB&(oM6|-cV%f(OX2C@A( zl0t=2Z?m!55&@&S5pKeiZ_O0e&$mMiUNDQf@L&s}+p!zWM}_Y;(P;)>y6E!gX2w?d zY>!A~svB;`_}g{~b04VzaaR!Nd_rXNmWRT)$F4HmYbrj?S!-yHybx(o@b!tOp(Pug zaYP+r(iVuajlUWf`XJfLR>AQf{H#K|&0#g~IxBVotAgTJsCsqL9_{h{DiE=)*Rr8lXo(2qfBmijObqL{F~+4CEs|36bWKUUgSiz_}@>Y z7dv$E8c+~q7aY~O@!yJiD)c~6FVK>Y<*&8QKXXqHsDXFiw#T#neMz{8X?z3efhuKq zk3`1bC+0;-<3}n`!z^FZaA5dv7xg~;0vuR6k6TwBESHtmw%FCPYg!m5^I ze$9UzDJq zhBIyGl+HxK6gtP%H`_qUnejk>3)>pEOQ{z`d+OR~`Ww8SXhFwZ$iCT4^MBcm=1N~I zDMfc+Q$SzZ(9<9~k}2>G1?~brm^e`3V%zJEDm0T9J^#9U3NtX?7&bH62PuD)DVlVT z{;~fXk^OFvmxdaX?}n}5_iGWUO)`mr6dEgy2F?OlDV>9};~PyP<(31}fY9za#{24> z+QHMqgLJX%dZYf2tIzos!R2Ms$ve3p9->F8RyI&JB=TotqIC&dl`~vvv3uZCQdGtA?1tIi5j?J9S-6IFF}&YhP&{do1~bbLQgXddM=j8A3l{wWpN!l+pw z$9ga~6hcz9sMcxavj>b^{HmTOd-jHat~?*W)-uqkz?XOhb@|0S70&9@JxK(U9?iajaZlYpO^pqB;Opw0TU_( ztik?#)>5wC%jP5)OqW8&dQ<2okMLYMapdme7?XxmG1c#zov*}LXl^PasfRF}=K|67AwDV{1@C75occcq2zVvL z+z;(gTIdaev0T2qLW8z%)HKuj9H@K7z>>2|n||hEM@g7YJq>W+yzFz6ZS2Uy)F1^F z0tds3xwn9CK0R?ka{lr8jn$`H*-Lz>+kgHBS{mO+PidLon^!%#;wRQ*Z@4~&vm8o0 zYHey@b(WhusAII3WTov%66&izAN2qjnr(5+$}nE^#>nmIuF1l>7|p(O8n{Z)wI|-q z-AP9tFZ`4MWh+0#6I+2@Dg*Ug^e-4w@$n=%Z<|h5X^#ox2X|>>daLagt!|~~ys~>F z#%DJ8Qe)0>5fd=BS0pl;jGv_1xms5_ZE09G8lQ*#;^!1#(K4qK21WA~^zdn0#YaO= zzQwJSFeTr_RB0K%Ejz2!CPEFo5(5~C-PuJF35pPyMVlA+>DP(!PHEOyd|8Q>7LQGg zsM#_s0b9`xd9h)~ydkm|Gq zA?0@V65i-wO8)I@L)inRnbA&XQ-zCaCX`h8jIhJ?Rl1&c2v7Y?xr8T#?V~k4@qCRsMdq^Kw$ zf~ZK7CPfedK@b8eN)ZsG7+SECN!;Qph%k2s* z>IawzKAHzx7Th0S=Qi)$Hk6=EjlM0lX&P5wG+L0IxDy{i87qf&{MZszanz`%vrW$1C| zvGq(w?*0^byiq)Pe0)LgYxz$b_U0l|CcCvLYohpoe4M^^A~*^%a|@=e_iyPC5bGsZ8v z9}=&6ly2k*k^&~);0d4vz8VO|CPHI>p^JchBYW-JG9(P~)jClfKNDvxYqu;CZM{0G z1S_*PWa&ni=-sok#WcFxjecIosUFs536eg|OixZqTdx`N&KGd#!0LW#t5L&-N9flQ zdt+V6-10{~x9-%vzH)N73{eC%jPtQx2OleupL8bO5nt|qT z9LFUFF1`2m9gfW3@iPP$(G&mX7xKR|@*$m3eIpk&$1+xjvA!F=t%}$}8wW{625>zA zQ<}#^9n~w@?D$LPM0a%R%2{Unw5Ff*?c8)zAfW*Sq=wS(aA%nYBtvrXsHjw3uK+Oh zo6TyE=6--S(1h}UISFw~Un#7&%WA9?b)J>p{ocnc>K-$M{CB|MOu!VQmB^ZhiA3l% zd!>9Dj(2y*nhf*SdpGJg7>bDjewBUFEg0tx5_S}lXOU9I7BVycASadlX@xm)u>75@2|kxs)H4^;!B3!^&^Cvs*ukkj+$mev2x*vhTs*j}+B) zcJ=EDUtBSBEweYho=u8d^xX~d1=yGzoPy3oDOFCdf`xbv`_tdII*c{i-NES@UF)v4 zeWgL{AIu#@bhon6<;IkCdC#8ro^Idw>Z1Pic_Hh8by?-Q@EffRE`){~C{405!cKQ$!OibG&rEqF|&Mkj-E8}=M4Sy+EiDQ}Gc+)4i8J%k@a)lWTum zvGahzKddx74XCU?KV|w3YK{~Xc;1-$0@Uzp8;9NEXF02N0<9Hs%H1iIMfIjbZf8df z2Dk0fmqrY^)OOg*Qi&f2##RUg_HD$Mi7>8f${wy16UH`cLk}mlLZFL3U>v5?)f`;# zlam#Pk`rt@FBOPG`aqQ!_38;`Zq{K5bARW3C*N-A1-y4@N{%@3jk4Hg=!d+b(t61) zsYeZ7ZqLd#jL)C=F?v73|Lw4|{|^6C)=C$oR_^a*XT29)I+F36OrfW&E%XmHzZ0T{ zq`ul!CVF%R|IF|tUH{BFkeY}ubR@}+|RP6W^1LJ8t|MKk?-a}jOKl7XsNom()+vfCg3xTF8xh+ z9yzX#ka~n|xFCKw=zhVRX)_0m}!^k&^>bDkYAZ?K2QjDwP}&AUZ7<&|Fd zdsf?`8Ir-D*`O;;VU24?on-;kLX5^bLChtA-+gSv=4iA>PyFxE>A@wVA*JXUPn@r8 z`N5rpk#6wm)$0JU?Kwn^O})m)$Yp8^nU_r_4bA5@2#BwC_2Vwsw-2~wrpfPJ5Yz*V zk3`tL+$`O)5pmW1AE?=YaiT9Rl^zk~By4Yzpju(f?uEi*b9Gij8)}O2s*emdLoj?;V@B*Y7VIwkk1`EY1z|yjV1IRCGSlZk7LUN2$F2Y z%-TuWC?ko*!Z4`%X2p?UbpTmPV#maB|?DY$?>4v;#ZbBb_$3JqBgLYc<6_eK}q=^ zh193d_pDR01xw4?H@R7+g7!wOuqf8e3sC7ojD~w|soZ*)vB;sBO&Zja{S}So5xgvW z;Ye$fAEux^0v_{GREK!!SKCvGknWllu8PlU*IpAQOimh{2eSwPnGrd4m_I)axd;X`z73lF33T9w4)GC26W||vvck^qgk=&sIvfsb+MY1P z0z-zBd7r=#9DD`V5{_0BxeCzvc}UlxO?RAaqOc#L*ktVO_NTn{o6f%*9d74$3J}*% ze{H{B1+ZUarnE*0l_4dMwVL`<>&GlCS>xrdo`Sf1XPb-v<%TxlzB(XTv%#n8)wt>F znBcUb>|CRrJhSS^~+pHb>Bmqu~8Q zQJJMy?vncHA;r%#F!B_}iSXS&w8lNZRAxiFYDQ$&;i&-e(ufL0cBBdNB zI9tAeiI&9Db<-8K#`&kWl-juTKSN#JH{G-jmUIJzq?CVk>zxdfU7o%Ea#7zzfRd-p ztPY@k3%HrJ2Q{l>wqPe3ei>wW<10qUJ4E~SBPrK9@}M73i}Vz`OEt?#i?$q#I}nAuJp zf`+mP%Uzw-&&2D74^L)=JBNB5=t;AnwO?nxtHDl|^!@YG*{*+DDQfVBetYJwbjEcm zTAS<4uN866W3ixi)b12vb^!}8#M5_?Yr}UChqmRtLX7SQwZXVtYeu1dM;asqA-jxRO37)CVq1Y5dgUUh-8v$>$X02;W*452?#aBMZz-gZ|RLSD0bHlj}!4@+NZINIpBFzFHw2KjNTV-td7`+kwmrdT5i-S$aTH z_}7YZUJv(35Pb^0{6LN5Mo)W)l2LYSXgmMPrgXZ!{ew-KnK6F5;%}Ou%k_KZ@-0yG>SLO^6HZQRf%(#mC8bBDbjI$x+?b0J(@>Ac zR|EL1!xz%ZL<@|Ig;K9#kKn%f7telO!m<+cKH`jvnPVyMlA6&9xsfsEj(OY1Es4}K zB9@h~+vNM73>Xe?S^y>Du5GFcU&6%5f&W*MjnXK|My;GxqWr0ZT6u{m+SyPCz7+O; z9i@Z!o&}blj(6I-eJaJcm3SCgP9)GzN0$z{R`zDum4o5Jm%ZX{T`jbmlZs-ZLp`o# zHWDMA_1@t69DgZhrBPz(z}D>AJA4$))6jD@%+Dcl0jiA*B0@dWq>t3Zh2o0=XK2Yz zzST!B+89-neM-F|QrgsZeZa>(Nr#5BjaUjOu^$GYmdMj)B$@JlBzU7>Q08dT>L@{b zmmbQ&Yoi@}q^kmuNTpqDBq=$rsi2)ZYG3bmN7HWggEZ+V>BKzjliE(!f0ad5rPgpb zRWL4eIZ=dv7Jx>1M?k77NmX0wWH4XU&RV2DzZa{!!Fl~G#G1xS<5)``#=zhfG3*p?kJ_6ahKl6--rl>VZ5~9YiYBtGV{!EZ(gC>NTPt!wZofF1t_x%9Y596z|t_sJXHcpN`{~`v~Mn=Rhs-& zTpW>o33^vUc})4m=YBo^)M)bsubp-J9$$2M2T1hr{-g>_cD}3B8U)9I3Ad+rx7v^{UA?17Mj}jfVQmB`uDyTh zqXh)IO|_~EWNrXH8j|9qV?US_IDmwAj0F4sQwvIG`rWP5F81e7_2QaM=g>-F>0`nM zyu%{(za?-xZJmNsUj>c(rJq?Zei_II+mFjexWs}50m=>~bwwNIujtylQLHh!jd8J` z;qyb5=*m?zsd)Jzp;Ef&HjH5)YtrhTr+fF<K#fPk^7pP=9|Ct-Zz0dSKGY5_#-tCgPBkV`R>Ic1cZsG+)-P(Z%h-=uX=H zvWKSW!X7JYP+OoT^v(sH8UDVlXG1~ zrO?(`@~7~_y{=!i0RUAP+^`l?AG-~9Ui}`1q0gGv)SYHQcBgDKh#uX^jX0O&B$>q2 zuY%S!1dG*1c3#O`D*xMDfuGf>@>>)(gWHRsKx^{Z3o2(WfXts(eKDGZ-uMEzA_W4t zg5~`en-CZEo!g;b41=MbCIgkB;Q>3fIsTVZkB_d%p1taIxOc7c@}b$X0f(1X*?=66 z9h;z{f^)#J5rJJU_kcU8Kv-Rsc!BR6e~u@;PQOJOY~;ZnUadkGZE9E_UqnkZ|FRGo_7h)k zHe1b!r+dT46Pr@hm;;awTwMN^b8y3X#^rr7M^S6qrS*rbn{$2M9CQ?}Yd*b}%emjt zHQE&crwHE-%mhq#htw?S3adaOo#6_g_ShkG1|ucU@&un+jEKbz4i6ld2x!z4IAYU_ z1ESch(pq=`dZ*2n_^ifr=G4x*FUo(Z-E$G;kIS_-e6P~ql`&4k^G^;;a}6^Jvq!BQ&< zJY616T@TRwS|ShU;hxM4HG{)A0x8RDv-^W&a{@1BfmkBD56?OjIA`9UHKr(R9a4@E9VzNa^+lvqo@!oV$rm?$kGEoly zb3%mo;vFWRaij;cjLq{##MD-u834s-67GHIF%|AX9sj_zNiIw{Cx&nQK%9jCxu6=v zUZr{GDpNF%RKaVS(RU5ZiRMXG7?lrW-CI?ahXrjDl zg#m!tR7vuxeM(J)iTu^w<5AR$!p7KJoTOJo+7XC~q6f2&lz=*-BJF70YBiQ8H^r?z z_!?M9Md8SKaTGfdNK$pJX$?y*oc~BZR(g|>BXDP7qzAcwZX0SIUyopoTKx~lp#pYAGBjp)yVjsB6Th`J*p zEX#+bhCdZL_<%fbqgZ2f`I=>}R`8tHekO&sTazfNM!ErzB2tuFzzj_JBL1JmEQ$gS zO>nEO3`25Y5noi25}!Wz5eiwE6&XGCX!v3Gkczlou)2NfHqGLkZ-L&8lWx&}d7E-@o>ZF;d68V$+{vKu*B@Q@?E2t+X6q z9^!>D=^D9eU0Xo94grsQB+?)fRvU-wCffnB1W$Z+!Ox#zgjInfbKb~fN)CuN+q}qf z(h2d{G?QX0mN~^dt>}e?fQLc5b_*;XAbqm@C;?W=RhJ*-8I{^&2~oJ#&1d?+3F*;$kR!(2Y8eCy`F% zM9sC|M{@Rh7DkTmcA5{CcLzgTMjhmXB+r=y6M zJU9SMGDk!apa$S>-hTilFbSVf$-YU}{!67ai?n?Xl=4UGe-W0JgQIP4v<&824Y%j| z*4u_Q0V*0)o7tshHb%Dm6@TG2zhC^60S+ULGDB(aG3$E_yD-h}&7*}@O8*@T`fkZ) zPoT!zJ4LvC_C`@1qj7PLf-9Djlu-YhABp~9Y)N93!FU3TDzc02ZtL;R1a6ZO!r*2} zk7LYC$F%V*yU%ugB8F`Chhew(R;}`~YeCPm3dR)u8dnG_z7>i0akc4|U^zSFyPy@b zo^^L%{s`~7tg5A-TIJ?wm#T^BMAc1k)%u-gfn2&_;9HHJ^OH!DTAvkGQAj%OX2Mx} zf}a;ZzDv~+*Or{Nczt*Vtt7r6pwctsC;s~=!ZJpN_|hK>%r3m=@BebY`vPir!toyJ zAr%j7V!hNN)zYBW;6AOofb?7D>*HG|pEP^e+;jPOe^2tJ{ly+-zvy1RBfP z->_&i3a*C=0-%Jy@Df)M|BUM2yzTBiWL@~r?P)!~kqOqlZIQ=}K~ zZ4$j$mrF=EE_+;wvbw^E z3+G^Z2q2Gnq`n8+@6H6_S$bTfH*=XCwf!|>kF5q=F5ZbD{B9%FP9G{1wWK>r5p&*+ zpo3dZX^pf7zI`3hlFML7jB!yC)192A?R8HfL+3$n3LA3IEt` zWxmE7G*2y)29+Pecy`NeFkR-qiwv-8OU_pG>x!DhDCxPnTzPvGRdmm4x;U6L4{FJm z4_Thoc1?%Z&;i7*s2b765{EMJl2mk^6mKFU(tB;fr6?n{c11#+cU$11qb8^~KE3mJr#05f?e{&>TC7W00!6V9wRL z;>fpDxu!#^)=kD9)6*+SFY->Tf%alal;7eI9h==9d;=}*$8{Io~*8!N=<$LIzWltb~8rP_8-_!A^sUU?aJe?%KdTLG@4{=HZ!D&k(m(VgnNBTew9 zd=tiun9R7c77Zd$#sZ47Ty`8wYcV#5Tl|m&K#E1QC$kY)dSt6ZpY7Fn|CP;`hvM+H z55So;!`Db_=tkh)$aMyYIxf=~JFAaz;BHixyr$Bq(97JIPLXu@R|R3-aBG~|Q>{&;aYXDD9Lq99V zeE#nBO4Vz_=!}=AS63|{_W-^T)hAP#6&XWxeZZZf6edQ}dcxZfUe#|Z zf4X3d@Vg__bx3E`oO8fd=#U{6`L^Y!#ca;CxSJ23e~O%qTw0jj=DppfBIf^OqInKE z)Ix)|leq0`1jLx#ShtdfwF$#Yk+}{)p*pA#0K@tjLCh+ag=s5AP>w;x=OnokFYm** zl?b7@*nN{liew=rV}~6%vN*odMX@O(BZ2L<_rk?ddig82q$}W}oL0m}njk81eQP;^ zRgO1dZ9h^4r45TRC&RwsKrsSzMbKB?M zfCBg0CEhKMW1(vlbUo*>j9fDDc0K>$5x5T^Na@n=A>Qn+Rzx>U`}#SJhKtDBRzW!# z?stDjx&Vp{cBF5%No?gs)d_rmYmN`k>U{CzspUgT2{2#h97T-#US;uEzL7arowQRzfivBLsqSD>CqJP&H^Ye} z_oFnIetn!5cocL$dBHiHZExmNiEI)uV$)rta$%4v?|3}G$Q=RujO18dDJ;!)Sw3qH;?I96 zaQXwNN{XxQe-Vml&5t7F&6plP(AOR~h{lH{7FAot3bA(lz0x)SFIiZ}m-X$BmE#wb zjR)IBrcXLIJIGfJZdhrb>SY%U&DM~$x48~9*fn({aR11!`&<8Jxv{epxcYwqmHtW3 z6r3U?CJneM_eb8cV_5$@O37s4+IsCF8+88-ddZ{?fGaIOF#QL2#NUtB_W&;>O*LZJ z{uujnt-n|Ltt7zk;8}tH0D=Df_|q1EbV}CyB4z(L@Si&efTzzT0K=J=wEr6hl_7r| z0I*uS6P-Q&^Vk0IrzK!mi97q$f3;f);5|q1`%4@D`D=e}NMR5#9P&i@^nbN$ei`t` z_ Date: Tue, 2 Mar 2021 15:40:10 -0500 Subject: [PATCH 05/52] ensure regex works for filter with optional multiple spaces (#93071) --- .../components/exploration_query_bar/exploration_query_bar.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx index dd451958e2646..3ef6dbc292c08 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx @@ -60,7 +60,7 @@ export const ExplorationQueryBar: FC = ({ const searchChangeHandler = (q: Query) => setSearchInput(q); - const regex = useMemo(() => new RegExp(`${filters?.columnId}\s?:\s?(true|false)`, 'g'), [ + const regex = useMemo(() => new RegExp(`${filters?.columnId}\\s*:\\s*(true|false)`, 'g'), [ filters?.columnId, ]); From a102fa9a70dce6a4d9c6392498b5737ebc10530e Mon Sep 17 00:00:00 2001 From: Yuliia Naumenko Date: Tue, 2 Mar 2021 13:43:10 -0800 Subject: [PATCH 06/52] [Alerting][Docs] Moved alerting links from hard-coded to documentation link service. (#92953) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [Alerting][Docs] Moved alerting links from hard-coded to documentation link service * fixed due to comments * Update x-pack/plugins/triggers_actions_ui/public/application/components/health_check.tsx Co-authored-by: Mike Côté * fixed jest tests * fixed due to comments Co-authored-by: Mike Côté --- .../public/doc_links/doc_links_service.ts | 10 ++-- .../alert_types/es_query/expression.test.tsx | 5 ++ .../alert_types/es_query/expression.tsx | 5 +- .../public/alert_types/es_query/index.ts | 4 +- .../public/alert_types/threshold/index.ts | 4 +- .../email/email_connector.tsx | 5 +- .../es_index/es_index_connector.tsx | 5 +- .../es_index/es_index_params.tsx | 5 +- .../pagerduty/pagerduty_connectors.tsx | 5 +- .../servicenow/servicenow_connectors.tsx | 5 +- .../slack/slack_connectors.tsx | 5 +- .../teams/teams_connectors.tsx | 5 +- .../application/components/health_check.tsx | 50 ++++--------------- .../public/application/home.tsx | 2 +- .../action_connector_form.tsx | 5 +- .../connector_edit_flyout.tsx | 5 +- 16 files changed, 33 insertions(+), 92 deletions(-) diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts index 7792e25e54d01..e985b5cd61e79 100644 --- a/src/core/public/doc_links/doc_links_service.ts +++ b/src/core/public/doc_links/doc_links_service.ts @@ -187,15 +187,17 @@ export class DocLinksService { guide: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/managing-alerts-and-actions.html`, actionTypes: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/action-types.html`, emailAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/email-action-type.html`, + emailActionConfig: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/email-action-type.html#configuring-email`, generalSettings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alert-action-settings-kb.html#general-alert-action-settings`, indexAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index-action-type.html`, - indexThreshold: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alert-types.html#alert-type-index-threshold`, + esQuery: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alert-type-es-query.html`, + indexThreshold: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alert-type-index-threshold.html#index-action-configuration`, pagerDutyAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/pagerduty-action-type.html`, preconfiguredConnectors: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/pre-configured-action-types-and-connectors.html`, - serviceNowAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/servicenow-action-type.html`, + serviceNowAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/servicenow-action-type.html#configuring-servicenow`, setupPrerequisites: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alerting-getting-started.html#alerting-setup-prerequisites`, - slackAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/slack-action-type.html`, - teamsAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/teams-action-type.html`, + slackAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/slack-action-type.html#configuring-slack`, + teamsAction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/teams-action-type.html#configuring-teams`, }, maps: { guide: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/maps.html`, diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.test.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.test.tsx index f475d97e2f39d..51c2f0471d486 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.test.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.test.tsx @@ -116,6 +116,11 @@ describe('EsQueryAlertTypeExpression', () => { docLinks: { ELASTIC_WEBSITE_URL: '', DOC_LINK_VERSION: '', + links: { + query: { + queryDsl: 'query-dsl.html', + }, + }, }, }, }); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.tsx b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.tsx index 37c64688ec49a..6adcada9b273a 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression.tsx @@ -287,10 +287,7 @@ export const EsQueryAlertTypeExpression: React.FunctionComponent< isInvalid={errors.esQuery.length > 0} error={errors.esQuery} helpText={ - + { defaultMessage: 'Alert on matches against an ES query.', }), iconClass: 'logoElastic', - documentationUrl(docLinks) { - return `${docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${docLinks.DOC_LINK_VERSION}/alert-types.html#alert-type-es-query`; - }, + documentationUrl: (docLinks) => docLinks.links.alerting.esQuery, alertParamsExpression: lazy(() => import('./expression')), validate: validateExpression, defaultActionMessage: i18n.translate( diff --git a/x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts b/x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts index 95ecd121cf5a2..1b229bb4a9d0a 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts +++ b/x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts @@ -18,9 +18,7 @@ export function getAlertType(): AlertTypeModel { defaultMessage: 'Alert when an aggregated query meets the threshold.', }), iconClass: 'alert', - documentationUrl(docLinks) { - return `${docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${docLinks.DOC_LINK_VERSION}/alert-types.html#alert-type-index-threshold`; - }, + documentationUrl: (docLinks) => docLinks.links.alerting.indexThreshold, alertParamsExpression: lazy(() => import('./expression')), validate: validateExpression, defaultActionMessage: i18n.translate( diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx index 2f518780c9f6b..df6822c85340a 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx @@ -55,10 +55,7 @@ export const EmailActionConnectorFields: React.FunctionComponent< } )} helpText={ - + - + + + + + + = ({ }; interface PromptErrorProps { - docLinks: Pick; + docLinks: DocLinksStart; className?: string; } -const EncryptionError = ({ - // eslint-disable-next-line @typescript-eslint/naming-convention - docLinks: { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION }, - className, -}: PromptErrorProps) => ( +const EncryptionError = ({ docLinks, className }: PromptErrorProps) => ( + {i18n.translate( 'xpack.triggersActionsUI.components.healthCheck.encryptionErrorAction', { @@ -151,11 +143,7 @@ const EncryptionError = ({ /> ); -const TlsError = ({ - // eslint-disable-next-line @typescript-eslint/naming-convention - docLinks: { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION }, - className, -}: PromptErrorProps) => ( +const TlsError = ({ docLinks, className }: PromptErrorProps) => ( + {i18n.translate('xpack.triggersActionsUI.components.healthCheck.tlsErrorAction', { defaultMessage: 'Learn how to enable TLS.', })} @@ -191,11 +175,7 @@ const TlsError = ({ /> ); -const AlertsError = ({ - // eslint-disable-next-line @typescript-eslint/naming-convention - docLinks: { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION }, - className, -}: PromptErrorProps) => ( +const AlertsError = ({ docLinks, className }: PromptErrorProps) => ( + {i18n.translate('xpack.triggersActionsUI.components.healthCheck.alertsErrorAction', { defaultMessage: 'Learn how to enable Alerts and Actions.', })} @@ -230,11 +206,7 @@ const AlertsError = ({ /> ); -const TlsAndEncryptionError = ({ - // eslint-disable-next-line @typescript-eslint/naming-convention - docLinks: { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION }, - className, -}: PromptErrorProps) => ( +const TlsAndEncryptionError = ({ docLinks, className }: PromptErrorProps) => ( + {i18n.translate( 'xpack.triggersActionsUI.components.healthCheck.tlsAndEncryptionErrorAction', { diff --git a/x-pack/plugins/triggers_actions_ui/public/application/home.tsx b/x-pack/plugins/triggers_actions_ui/public/application/home.tsx index 1e7fa3c51e689..c251a1d597f27 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/home.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/home.tsx @@ -99,7 +99,7 @@ export const TriggersActionsUIHome: React.FunctionComponent + - + Date: Tue, 2 Mar 2021 16:46:09 -0500 Subject: [PATCH 07/52] [Maps] Abort ES-search when tile request is cancelled (#92069) --- x-pack/plugins/maps/server/mvt/get_tile.ts | 18 ++++++++++++++++-- x-pack/plugins/maps/server/mvt/mvt_routes.ts | 15 +++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/maps/server/mvt/get_tile.ts b/x-pack/plugins/maps/server/mvt/get_tile.ts index 50c2014275a0f..3274261cdba56 100644 --- a/x-pack/plugins/maps/server/mvt/get_tile.ts +++ b/x-pack/plugins/maps/server/mvt/get_tile.ts @@ -28,6 +28,10 @@ import { flattenHit } from './util'; import { ESBounds, tileToESBbox } from '../../common/geo_tile_utils'; import { getCentroidFeatures } from '../../common/get_centroid_features'; +function isAbortError(error: Error) { + return error.message === 'Request aborted' || error.message === 'Aborted'; +} + export async function getGridTile({ logger, context, @@ -40,6 +44,7 @@ export async function getGridTile({ requestType = RENDER_AS.POINT, geoFieldType = ES_GEO_FIELD_TYPE.GEO_POINT, searchSessionId, + abortSignal, }: { x: number; y: number; @@ -52,6 +57,7 @@ export async function getGridTile({ requestType: RENDER_AS; geoFieldType: ES_GEO_FIELD_TYPE; searchSessionId?: string; + abortSignal: AbortSignal; }): Promise { try { const tileBounds: ESBounds = tileToESBbox(x, y, z); @@ -72,6 +78,7 @@ export async function getGridTile({ }, { sessionId: searchSessionId, + abortSignal, } ) .toPromise(); @@ -83,7 +90,9 @@ export async function getGridTile({ return createMvtTile(featureCollection, z, x, y); } catch (e) { - logger.warn(`Cannot generate grid-tile for ${z}/${x}/${y}: ${e.message}`); + if (!isAbortError(e)) { + logger.warn(`Cannot generate grid-tile for ${z}/${x}/${y}: ${e.message}`); + } return null; } } @@ -99,6 +108,7 @@ export async function getTile({ requestBody = {}, geoFieldType, searchSessionId, + abortSignal, }: { x: number; y: number; @@ -110,6 +120,7 @@ export async function getTile({ requestBody: any; geoFieldType: ES_GEO_FIELD_TYPE; searchSessionId?: string; + abortSignal: AbortSignal; }): Promise { let features: Feature[]; try { @@ -119,6 +130,7 @@ export async function getTile({ const searchOptions = { sessionId: searchSessionId, + abortSignal, }; const countResponse = await context @@ -214,7 +226,9 @@ export async function getTile({ return createMvtTile(featureCollection, z, x, y); } catch (e) { - logger.warn(`Cannot generate tile for ${z}/${x}/${y}: ${e.message}`); + if (!isAbortError(e)) { + logger.warn(`Cannot generate tile for ${z}/${x}/${y}: ${e.message}`); + } return null; } } diff --git a/x-pack/plugins/maps/server/mvt/mvt_routes.ts b/x-pack/plugins/maps/server/mvt/mvt_routes.ts index 3e16176579586..1423e4ef5a20d 100644 --- a/x-pack/plugins/maps/server/mvt/mvt_routes.ts +++ b/x-pack/plugins/maps/server/mvt/mvt_routes.ts @@ -10,6 +10,8 @@ import { schema } from '@kbn/config-schema'; import { KibanaRequest, KibanaResponseFactory, Logger } from 'src/core/server'; import { IRouter } from 'src/core/server'; import type { DataRequestHandlerContext } from 'src/plugins/data/server'; +// @ts-ignore not typed +import { AbortController } from 'abortcontroller-polyfill/dist/cjs-ponyfill'; import { MVT_GETTILE_API_PATH, API_ROOT_PATH, @@ -50,6 +52,12 @@ export function initMVTRoutes({ response: KibanaResponseFactory ) => { const { query } = request; + + const abortController = new AbortController(); + request.events.aborted$.subscribe(() => { + abortController.abort(); + }); + const requestBodyDSL = rison.decode(query.requestBody as string); const tile = await getTile({ @@ -63,6 +71,7 @@ export function initMVTRoutes({ requestBody: requestBodyDSL as any, geoFieldType: query.geoFieldType as ES_GEO_FIELD_TYPE, searchSessionId: query.searchSessionId, + abortSignal: abortController.signal, }); return sendResponse(response, tile); @@ -92,6 +101,11 @@ export function initMVTRoutes({ response: KibanaResponseFactory ) => { const { query } = request; + const abortController = new AbortController(); + request.events.aborted$.subscribe(() => { + abortController.abort(); + }); + const requestBodyDSL = rison.decode(query.requestBody as string); const tile = await getGridTile({ @@ -106,6 +120,7 @@ export function initMVTRoutes({ requestType: query.requestType as RENDER_AS, geoFieldType: query.geoFieldType as ES_GEO_FIELD_TYPE, searchSessionId: query.searchSessionId, + abortSignal: abortController.signal, }); return sendResponse(response, tile); From 819cb485dcb51a4a68bf1b23a8d442e770c984c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ece=20=C3=96zalp?= Date: Tue, 2 Mar 2021 16:47:09 -0500 Subject: [PATCH 08/52] Add searchDuration to EQL and Threshold rules (#93149) Closes #82861. --- .../signals/signal_rule_alert_type.ts | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts index f81f4c5a2c537..45d3986a1c115 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts @@ -12,6 +12,7 @@ import isEmpty from 'lodash/isEmpty'; import { chain, tryCatch } from 'fp-ts/lib/TaskEither'; import { flow } from 'fp-ts/lib/function'; +import { performance } from 'perf_hooks'; import { toError, toPromise } from '../../../../common/fp_utils'; import { @@ -50,6 +51,7 @@ import { hasTimestampFields, hasReadIndexPrivileges, getRuleRangeTuples, + makeFloatString, } from './utils'; import { signalParamsSchema } from './signal_params_schema'; import { siemRuleActionGroups } from './siem_rule_action_groups'; @@ -402,7 +404,11 @@ export const signalRulesAlertType = ({ lists: exceptionItems ?? [], }); - const { searchResult: thresholdResults, searchErrors } = await findThresholdSignals({ + const { + searchResult: thresholdResults, + searchErrors, + searchDuration: thresholdSearchDuration, + } = await findThresholdSignals({ inputIndexPattern: inputIndex, from, to, @@ -457,6 +463,7 @@ export const signalRulesAlertType = ({ createdSignalsCount: createdItemsCount, createdSignals: createdItems, bulkCreateTimes: bulkCreateDuration ? [bulkCreateDuration] : [], + searchAfterTimes: [thresholdSearchDuration], }), ]); } else if (isThreatMatchRule(type)) { @@ -590,10 +597,14 @@ export const signalRulesAlertType = ({ exceptionItems ?? [], eventCategoryOverride ); + const eqlSignalSearchStart = performance.now(); const response: EqlSignalSearchResponse = await services.callCluster( 'transport.request', request ); + const eqlSignalSearchEnd = performance.now(); + const eqlSearchDuration = makeFloatString(eqlSignalSearchEnd - eqlSignalSearchStart); + result.searchAfterTimes = [eqlSearchDuration]; let newSignals: WrappedSignalHit[] | undefined; if (response.hits.sequences !== undefined) { newSignals = response.hits.sequences.reduce( @@ -634,7 +645,6 @@ export const signalRulesAlertType = ({ const fromInMs = parseScheduleDates(`now-${interval}`)?.format('x'); const toInMs = parseScheduleDates('now')?.format('x'); - const resultsLink = getNotificationResultsLink({ from: fromInMs, to: toInMs, From 21338080db6d3bf8d202ceed6381f65d7e2bb524 Mon Sep 17 00:00:00 2001 From: Aaron Caldwell Date: Tue, 2 Mar 2021 16:48:02 -0500 Subject: [PATCH 09/52] [Maps] Update Map extent queries to use bounding box logic for both point and shape queries (#93156) --- .../elasticsearch_geo_utils.d.ts | 3 +- .../elasticsearch_geo_utils.js | 26 +-- .../elasticsearch_geo_utils.test.js | 202 +++++++----------- .../classes/sources/es_source/es_source.ts | 8 +- 4 files changed, 84 insertions(+), 155 deletions(-) diff --git a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.d.ts b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.d.ts index d7d76ab8acd37..2a3741146d454 100644 --- a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.d.ts +++ b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.d.ts @@ -47,8 +47,7 @@ export interface ESPolygonFilter { export function createExtentFilter( mapExtent: MapExtent, - geoFieldName: string, - geoFieldType: ES_GEO_FIELD_TYPE + geoFieldName: string ): ESPolygonFilter | ESGeoBoundingBoxFilter; export function makeESBbox({ maxLat, maxLon, minLat, minLon }: MapExtent): ESBBox; diff --git a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.js b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.js index c6b1c712925f0..47de8850c0e96 100644 --- a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.js +++ b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.js @@ -280,8 +280,8 @@ export function makeESBbox({ maxLat, maxLon, minLat, minLon }) { return esBbox; } -function createGeoBoundBoxFilter({ maxLat, maxLon, minLat, minLon }, geoFieldName) { - const boundingBox = makeESBbox({ maxLat, maxLon, minLat, minLon }); +export function createExtentFilter(mapExtent, geoFieldName) { + const boundingBox = makeESBbox(mapExtent); return { geo_bounding_box: { [geoFieldName]: boundingBox, @@ -289,28 +289,6 @@ function createGeoBoundBoxFilter({ maxLat, maxLon, minLat, minLon }, geoFieldNam }; } -export function createExtentFilter(mapExtent, geoFieldName, geoFieldType) { - ensureGeoField(geoFieldType); - - // Extent filters are used to dynamically filter data for the current map view port. - // Continue to use geo_bounding_box queries for extent filters - // 1) geo_bounding_box queries are faster than polygon queries - // 2) geo_shape benefits of pre-indexed shapes and - // compatability across multi-indices with geo_point and geo_shape do not apply to this use case. - if (geoFieldType === ES_GEO_FIELD_TYPE.GEO_POINT) { - return createGeoBoundBoxFilter(mapExtent, geoFieldName); - } - - return { - geo_shape: { - [geoFieldName]: { - shape: formatEnvelopeAsPolygon(mapExtent), - relation: ES_SPATIAL_RELATIONS.INTERSECTS, - }, - }, - }; -} - export function createSpatialFilterWithGeometry({ preIndexedShape, geometry, diff --git a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.test.js b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.test.js index aed9ccbb96c3b..9983bb9b84588 100644 --- a/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.test.js +++ b/x-pack/plugins/maps/common/elasticsearch_util/elasticsearch_geo_utils.test.js @@ -389,143 +389,99 @@ describe('geoShapeToGeometry', () => { }); describe('createExtentFilter', () => { - describe('geo_point field', () => { - it('should return elasticsearch geo_bounding_box filter for geo_point field', () => { - const mapExtent = { - maxLat: 39, - maxLon: -83, - minLat: 35, - minLon: -89, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_point'); - expect(filter).toEqual({ - geo_bounding_box: { - location: { - top_left: [-89, 39], - bottom_right: [-83, 35], - }, - }, - }); - }); - - it('should clamp longitudes to -180 to 180 and latitudes to -90 to 90', () => { - const mapExtent = { - maxLat: 120, - maxLon: 200, - minLat: -100, - minLon: -190, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_point'); - expect(filter).toEqual({ - geo_bounding_box: { - location: { - top_left: [-180, 89], - bottom_right: [180, -89], - }, + it('should return elasticsearch geo_bounding_box filter', () => { + const mapExtent = { + maxLat: 39, + maxLon: -83, + minLat: 35, + minLon: -89, + }; + const filter = createExtentFilter(mapExtent, geoFieldName); + expect(filter).toEqual({ + geo_bounding_box: { + location: { + top_left: [-89, 39], + bottom_right: [-83, 35], }, - }); + }, }); + }); - it('should make left longitude greater then right longitude when area crosses 180 meridian east to west', () => { - const mapExtent = { - maxLat: 39, - maxLon: 200, - minLat: 35, - minLon: 100, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_point'); - const leftLon = filter.geo_bounding_box.location.top_left[0]; - const rightLon = filter.geo_bounding_box.location.bottom_right[0]; - expect(leftLon).toBeGreaterThan(rightLon); - expect(filter).toEqual({ - geo_bounding_box: { - location: { - top_left: [100, 39], - bottom_right: [-160, 35], - }, + it('should clamp longitudes to -180 to 180 and latitudes to -90 to 90', () => { + const mapExtent = { + maxLat: 120, + maxLon: 200, + minLat: -100, + minLon: -190, + }; + const filter = createExtentFilter(mapExtent, geoFieldName); + expect(filter).toEqual({ + geo_bounding_box: { + location: { + top_left: [-180, 89], + bottom_right: [180, -89], }, - }); + }, }); + }); - it('should make left longitude greater then right longitude when area crosses 180 meridian west to east', () => { - const mapExtent = { - maxLat: 39, - maxLon: -100, - minLat: 35, - minLon: -200, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_point'); - const leftLon = filter.geo_bounding_box.location.top_left[0]; - const rightLon = filter.geo_bounding_box.location.bottom_right[0]; - expect(leftLon).toBeGreaterThan(rightLon); - expect(filter).toEqual({ - geo_bounding_box: { - location: { - top_left: [160, 39], - bottom_right: [-100, 35], - }, + it('should make left longitude greater then right longitude when area crosses 180 meridian east to west', () => { + const mapExtent = { + maxLat: 39, + maxLon: 200, + minLat: 35, + minLon: 100, + }; + const filter = createExtentFilter(mapExtent, geoFieldName); + const leftLon = filter.geo_bounding_box.location.top_left[0]; + const rightLon = filter.geo_bounding_box.location.bottom_right[0]; + expect(leftLon).toBeGreaterThan(rightLon); + expect(filter).toEqual({ + geo_bounding_box: { + location: { + top_left: [100, 39], + bottom_right: [-160, 35], }, - }); + }, }); }); - describe('geo_shape field', () => { - it('should return elasticsearch geo_shape filter', () => { - const mapExtent = { - maxLat: 39, - maxLon: -83, - minLat: 35, - minLon: -89, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_shape'); - expect(filter).toEqual({ - geo_shape: { - location: { - relation: 'INTERSECTS', - shape: { - coordinates: [ - [ - [-89, 39], - [-89, 35], - [-83, 35], - [-83, 39], - [-89, 39], - ], - ], - type: 'Polygon', - }, - }, + it('should make left longitude greater then right longitude when area crosses 180 meridian west to east', () => { + const mapExtent = { + maxLat: 39, + maxLon: -100, + minLat: 35, + minLon: -200, + }; + const filter = createExtentFilter(mapExtent, geoFieldName); + const leftLon = filter.geo_bounding_box.location.top_left[0]; + const rightLon = filter.geo_bounding_box.location.bottom_right[0]; + expect(leftLon).toBeGreaterThan(rightLon); + expect(filter).toEqual({ + geo_bounding_box: { + location: { + top_left: [160, 39], + bottom_right: [-100, 35], }, - }); + }, }); + }); - it('should clamp longitudes to -180 to 180 when lonitude wraps globe', () => { - const mapExtent = { - maxLat: 39, - maxLon: 209, - minLat: 35, - minLon: -191, - }; - const filter = createExtentFilter(mapExtent, geoFieldName, 'geo_shape'); - expect(filter).toEqual({ - geo_shape: { - location: { - relation: 'INTERSECTS', - shape: { - coordinates: [ - [ - [-180, 39], - [-180, 35], - [180, 35], - [180, 39], - [-180, 39], - ], - ], - type: 'Polygon', - }, - }, + it('should clamp longitudes to -180 to 180 when longitude wraps globe', () => { + const mapExtent = { + maxLat: 39, + maxLon: 209, + minLat: 35, + minLon: -191, + }; + const filter = createExtentFilter(mapExtent, geoFieldName); + expect(filter).toEqual({ + geo_bounding_box: { + location: { + top_left: [-180, 39], + bottom_right: [180, 35], }, - }); + }, }); }); }); diff --git a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts index f6f0a234bcd67..6b99f1f8860c0 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts @@ -34,7 +34,7 @@ import { import { IVectorStyle } from '../../styles/vector/vector_style'; import { IDynamicStyleProperty } from '../../styles/vector/properties/dynamic_style_property'; import { IField } from '../../fields/field'; -import { ES_GEO_FIELD_TYPE, FieldFormatter } from '../../../../common/constants'; +import { FieldFormatter } from '../../../../common/constants'; import { Adapters, RequestResponder, @@ -236,11 +236,7 @@ export class AbstractESSource extends AbstractVectorSource implements IESSource typeof searchFilters.geogridPrecision === 'number' ? expandToTileBoundaries(searchFilters.buffer, searchFilters.geogridPrecision) : searchFilters.buffer; - const extentFilter = createExtentFilter( - buffer, - geoField.name, - geoField.type as ES_GEO_FIELD_TYPE - ); + const extentFilter = createExtentFilter(buffer, geoField.name); // @ts-expect-error allFilters.push(extentFilter); From 9d1df3f6f4efecc517c23e9f09a52aa8dd8687f8 Mon Sep 17 00:00:00 2001 From: Tiago Costa Date: Tue, 2 Mar 2021 21:56:02 +0000 Subject: [PATCH 10/52] chore(NA): do not include fs within a storybook build (#93294) --- packages/kbn-storybook/lib/default_config.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/kbn-storybook/lib/default_config.ts b/packages/kbn-storybook/lib/default_config.ts index 1b049761a3a98..e194c9789daab 100644 --- a/packages/kbn-storybook/lib/default_config.ts +++ b/packages/kbn-storybook/lib/default_config.ts @@ -19,6 +19,9 @@ export const defaultConfig: StorybookConfig = { config.parallelism = 4; config.cache = true; } + + config.node = { fs: 'empty' }; + return config; }, }; From 42188134642a6c35373b95923bc4333668ad12cf Mon Sep 17 00:00:00 2001 From: Bhavya RM Date: Tue, 2 Mar 2021 17:21:28 -0500 Subject: [PATCH 11/52] removing the linked issue in comments from PR (#93303) --- test/functional/apps/management/_import_objects.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/test/functional/apps/management/_import_objects.ts b/test/functional/apps/management/_import_objects.ts index ca8d8c392ce49..a3daaf8629493 100644 --- a/test/functional/apps/management/_import_objects.ts +++ b/test/functional/apps/management/_import_objects.ts @@ -23,7 +23,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const testSubjects = getService('testSubjects'); const log = getService('log'); - // FLAKY: https://github.com/elastic/kibana/issues/89478 describe('import objects', function describeIndexTests() { describe('.ndjson file', () => { beforeEach(async function () { From 3b6643144d6e7228bf176c87341131ec4e6ab416 Mon Sep 17 00:00:00 2001 From: Spencer Date: Tue, 2 Mar 2021 16:03:00 -0700 Subject: [PATCH 12/52] [jenkins] convert baseline capture job to use tasks (#93288) Co-authored-by: spalger --- .ci/Jenkinsfile_baseline_capture | 62 ++++++++++++---------- src/dev/ci_setup/bootstrap_validations.sh | 64 +++++++++++++++++++++++ src/dev/ci_setup/setup.sh | 62 ++-------------------- 3 files changed, 103 insertions(+), 85 deletions(-) create mode 100644 src/dev/ci_setup/bootstrap_validations.sh diff --git a/.ci/Jenkinsfile_baseline_capture b/.ci/Jenkinsfile_baseline_capture index 6993dc9e087f9..672f5127a9796 100644 --- a/.ci/Jenkinsfile_baseline_capture +++ b/.ci/Jenkinsfile_baseline_capture @@ -3,40 +3,48 @@ library 'kibana-pipeline-library' kibanaLibrary.load() -kibanaPipeline(timeoutMinutes: 120) { +kibanaPipeline(timeoutMinutes: 210) { githubCommitStatus.trackBuild(params.commit, 'kibana-ci-baseline') { ciStats.trackBuild { - catchError { - withEnv([ - 'CI_PARALLEL_PROCESS_NUMBER=1' - ]) { - parallel([ - 'oss-baseline': { - workers.ci(name: 'oss-baseline', size: 'l', ramDisk: true, runErrorReporter: false, bootstrapped: false) { - // bootstrap ourselves, but with the env needed to upload the ts refs cache - withGcpServiceAccount.fromVaultSecret('secret/kibana-issues/dev/ci-artifacts-key', 'value') { - withEnv([ - 'BUILD_TS_REFS_CACHE_ENABLE=true', - 'BUILD_TS_REFS_CACHE_CAPTURE=true' - ]) { - kibanaPipeline.doSetup() - } - } + catchErrors { + slackNotifications.onFailure( + title: "*<${env.BUILD_URL}|[${params.branch}] Baseline Capture Failure>*", + message: "[${params.branch}/${params.commit}] Baseline Capture Failure", + ) { + retryable.enable(2) - kibanaPipeline.functionalTestProcess('oss-baseline', './test/scripts/jenkins_baseline.sh')() + catchErrors { + workers.ci( + name: 'baseline-worker', + size: 'xl', + ramDisk: true, + runErrorReporter: false, + bootstrapped: false + ) { + withGcpServiceAccount.fromVaultSecret('secret/kibana-issues/dev/ci-artifacts-key', 'value') { + withEnv([ + 'BUILD_TS_REFS_CACHE_ENABLE=true', + 'BUILD_TS_REFS_CACHE_CAPTURE=true', + 'DISABLE_BOOTSTRAP_VALIDATIONS=true', + ]) { + kibanaPipeline.doSetup() + } } - }, - 'xpack-baseline': { - workers.ci(name: 'xpack-baseline', size: 'l', ramDisk: true, runErrorReporter: false) { - kibanaPipeline.functionalTestProcess('xpack-baseline', './test/scripts/jenkins_xpack_baseline.sh')() + + kibanaPipeline.withCiTaskQueue([parallel: 2]) { + catchErrors { + tasks([ + kibanaPipeline.functionalTestProcess('oss-baseline', './test/scripts/jenkins_baseline.sh'), + kibanaPipeline.functionalTestProcess('xpack-baseline', './test/scripts/jenkins_xpack_baseline.sh'), + ]) + } } - }, - ]) + } + } } } - - kibanaPipeline.sendMail() - slackNotifications.onFailure() } + + kibanaPipeline.sendMail() } } diff --git a/src/dev/ci_setup/bootstrap_validations.sh b/src/dev/ci_setup/bootstrap_validations.sh new file mode 100644 index 0000000000000..939269952dea1 --- /dev/null +++ b/src/dev/ci_setup/bootstrap_validations.sh @@ -0,0 +1,64 @@ +#!/usr/bin/env bash + +set -e + +### +### verify no git modifications caused by bootstrap +### +if [[ $DISABLE_BOOTSTRAP_VALIDATIONS != "true" ]]; then + GIT_CHANGES="$(git ls-files --modified)" + if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'yarn kbn bootstrap' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 + fi +fi + + +### +### rebuild kbn-pm distributable to ensure it's not out of date +### +echo " -- building kbn-pm distributable" +yarn kbn run build -i @kbn/pm + +### +### verify no git modifications +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'yarn kbn run build -i @kbn/pm' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi + +### +### rebuild plugin list to ensure it's not out of date +### +echo " -- building plugin list docs" +node scripts/build_plugin_list_docs + +### +### verify no git modifications +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'node scripts/build_plugin_list_docs' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi + +### +### rebuild plugin api docs to ensure it's not out of date +### +echo " -- building api docs" +node scripts/build_api_docs + +### +### verify no api changes +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'node scripts/build_api_docs' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi diff --git a/src/dev/ci_setup/setup.sh b/src/dev/ci_setup/setup.sh index b685b32038f8e..3c08b336f1628 100755 --- a/src/dev/ci_setup/setup.sh +++ b/src/dev/ci_setup/setup.sh @@ -40,66 +40,12 @@ if [[ "$BUILD_TS_REFS_CACHE_CAPTURE" == "true" ]]; then cd "$KIBANA_DIR" fi +if [[ "$DISABLE_BOOTSTRAP_VALIDATIONS" != "true" ]]; then + source "$KIBANA_DIR/src/dev/ci_setup/bootstrap_validations.sh" +fi + ### ### Download es snapshots ### echo " -- downloading es snapshot" node scripts/es snapshot --download-only; - -### -### verify no git modifications -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'yarn kbn bootstrap' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi - -### -### rebuild kbn-pm distributable to ensure it's not out of date -### -echo " -- building kbn-pm distributable" -yarn kbn run build -i @kbn/pm - -### -### verify no git modifications -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'yarn kbn run build -i @kbn/pm' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi - -### -### rebuild plugin list to ensure it's not out of date -### -echo " -- building plugin list docs" -node scripts/build_plugin_list_docs - -### -### verify no git modifications -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'node scripts/build_plugin_list_docs' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi - -### -### rebuild plugin api docs to ensure it's not out of date -### -echo " -- building api docs" -node scripts/build_api_docs - -### -### verify no api changes -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'node scripts/build_api_docs' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi \ No newline at end of file From fda67adb9f8606e5f8ce8e314ad79e7c1b61c0d1 Mon Sep 17 00:00:00 2001 From: ymao1 Date: Tue, 2 Mar 2021 18:08:58 -0500 Subject: [PATCH 13/52] [Alerting][Docs] Adding template for documenting alert and action types (#92830) * Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/action-type-template.asciidoc | 73 ++++++++ docs/alert-type-template.asciidoc | 39 +++++ .../user/alerting/action-types/email.asciidoc | 59 +++---- .../user/alerting/action-types/index.asciidoc | 31 ++-- docs/user/alerting/action-types/jira.asciidoc | 39 ++--- .../alerting/action-types/pagerduty.asciidoc | 156 ++++++------------ .../alerting/action-types/resilient.asciidoc | 39 ++--- .../alerting/action-types/server-log.asciidoc | 7 +- .../alerting/action-types/servicenow.asciidoc | 35 ++-- .../user/alerting/action-types/slack.asciidoc | 22 +-- .../user/alerting/action-types/teams.asciidoc | 21 +-- .../alerting/action-types/webhook.asciidoc | 48 ++---- docs/user/alerting/alert-types.asciidoc | 5 +- docs/user/alerting/defining-alerts.asciidoc | 9 +- .../images/slack-copy-webhook-url.png | Bin 42332 -> 21738 bytes .../alerting/stack-alerts/es-query.asciidoc | 33 ++-- .../stack-alerts/index-threshold.asciidoc | 74 ++++----- x-pack/plugins/actions/README.md | 4 +- x-pack/plugins/alerts/README.md | 18 +- 19 files changed, 335 insertions(+), 377 deletions(-) create mode 100644 docs/action-type-template.asciidoc create mode 100644 docs/alert-type-template.asciidoc diff --git a/docs/action-type-template.asciidoc b/docs/action-type-template.asciidoc new file mode 100644 index 0000000000000..5b61c259563ad --- /dev/null +++ b/docs/action-type-template.asciidoc @@ -0,0 +1,73 @@ +[[-action-type]] +=== action +++++ + +++++ + +Include a short description of the action type. + +[float] +[[-connector-configuration]] +==== Connector configuration + + connectors have the following configuration properties. + +//// +List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this action type. +//// + +Property1:: A short description of this property. +Property2:: A short description of this property with format hints. This can be specified in `this specific format`. + +[float] +[[Preconfigured--configuration]] +==== Preconfigured action type + +//// +Example preconfigured format for this action type +//// + +[source,text] +-- + my-: + name: preconfigured--action-type + actionTypeId: . + config: + property1: value1 + property2: value2 + secrets: + property3: value3 +-- + +[float] +[[-connector-config-properties]] +//// +List of properties from the ConfigSchema and SecretsSchema for this action type. +//// +Config defines information for the action type. + +`property1`:: A short description of this property. +`property2`:: A short descriptionn of this property. + +Secrets defines sensitive information for the action type. + +`property3`:: A short descriptionn of this property. + +[float] +[[-action-configuration]] +==== Action configuration + + actions have the following configuration properties. + +//// +List of user-facing action configurations. This should align with the fields available in the Action section of the Create/Update alert flyout. +//// + +Property1:: A short description of this property. +Property2:: A short description of this property with format hints. This can be specified in `this specific format`. + +//// +Optional - additional configuration details here +[[configuring-]] +==== Configure +//// diff --git a/docs/alert-type-template.asciidoc b/docs/alert-type-template.asciidoc new file mode 100644 index 0000000000000..292ed00d05496 --- /dev/null +++ b/docs/alert-type-template.asciidoc @@ -0,0 +1,39 @@ +[[alert-type-]] +=== + +Include a short description of the alert type. + +[float] +==== Create the alert + +Fill in the <>, then select **. + +[float] +==== Define the conditions + +Define properties to detect the condition. + +//// +Optional, include a screenshot +[role="screenshot"] +image::user/alerting/images/alert-types--conditions.png[Conditions for alert type] +//// + +Condition1:: This is a condition the user must define. +Condition2:: This is another condition the user must define. + +[float] +==== Add action variables + +<> to run when the alert condition is met. The following variables are specific to the alert. You can also specify <>. + +`context.variableA`:: A short description of the context variable defined by the alert type. +`context.variableB`:: A short description of the context variable defined by the alert type with an example. Example: `this is what variableB outputs`. + +//// +Optional, include a step-by-step example for creating this alert +[float] +==== Example + +In this section, you will use the {kib} <> to setup and tune the conditions on an alert. For this example, we want to detect when . +//// \ No newline at end of file diff --git a/docs/user/alerting/action-types/email.asciidoc b/docs/user/alerting/action-types/email.asciidoc index 0c238da1b39e3..3813eccd048d9 100644 --- a/docs/user/alerting/action-types/email.asciidoc +++ b/docs/user/alerting/action-types/email.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[email-action-type]] === Email action +++++ +Email +++++ The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text. @@ -10,14 +13,15 @@ NOTE: For emails to have a footer with a link back to {kib}, set the <"` format. See the https://nodemailer.com/message/addresses/[Nodemailer address documentation] for more information. Host:: Host name of the service provider. If you are using the <> setting, make sure this hostname is added to the allowed hosts. Port:: The port to connect to on the service provider. Secure:: If true, the connection will use TLS when connecting to the service provider. Refer to the https://nodemailer.com/smtp/#tls-options[Nodemailer TLS documentation] for more information. If not true, the connection will initially connect over TCP, then attempt to switch to TLS via the SMTP STARTTLS command. -User:: Username for login type authentication. +Require authentication:: If true, a username and password for login type authentication must be provided. +Username:: Username for login type authentication. Password:: Password for login type authentication. [float] @@ -39,56 +43,33 @@ Password:: Password for login type authentication. password: passwordkeystorevalue -- -[[email-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: +Config defines information for the action type. -[cols="2*<"] -|=== +`service`:: The name of a https://nodemailer.com/smtp/well-known/[well-known email service provider]. If `service` is provided, `host`, `port`, and `secure` properties are ignored. For more information on the `gmail` service value, see the https://nodemailer.com/usage/using-gmail/[Nodemailer Gmail documentation]. +`from`:: An email address that corresponds to *Sender*. +`host`:: A string that corresponds to *Host*. +`port`:: A number that corresponds to *Port*. +`secure`:: A boolean that corresponds to *Secure*. +`hasAuth`:: A boolean that corresponds to *Requires authentication*. If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`. -| `service` -| The name of a https://nodemailer.com/smtp/well-known/[well-known email service provider]. If `service` is provided, `host`, `port`, and `secure` properties are ignored. For more information on the `gmail` service value, see the (https://nodemailer.com/usage/using-gmail/)[Nodemailer Gmail documentation]. +Secrets defines sensitive information for the action type. -| `from` -| An email address that corresponds to *Sender*. +`user`:: A string that corresponds to *Username*. Required if `hasAuth` is set to `true`. +`password`:: A string that corresponds to *Password*. Should be stored in the <>. Required if `hasAuth` is set to `true`. -| `host` -| A string that corresponds to *Host*. - -| `port` -| A number that corresponds to *Port*. - -| `secure` -| A boolean that corresponds to *Secure*. - -| `hasAuth` -| If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`. - -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -| `user` -| A string that corresponds to *User*. Required if `hasAuth` is set to `true`. - -| `password` -| A string that corresponds to *Password*. Should be stored in the <>. Required if `hasAuth` is set to `true`. - -|=== +[float] [[email-action-configuration]] ==== Action configuration -Email actions have the following configuration properties: +Email actions have the following configuration properties. -To, CC, BCC:: Each is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name ` format. One of To, CC, or BCC must contain an entry. +To, CC, BCC:: Each item is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name ` format. One of To, CC, or BCC must contain an entry. Subject:: The subject line of the email. Message:: The message text of the email. Markdown format is supported. [[configuring-email]] -==== Configuring email accounts +==== Configuring email accounts for well-known services The email action can send email using many popular SMTP email services. diff --git a/docs/user/alerting/action-types/index.asciidoc b/docs/user/alerting/action-types/index.asciidoc index 7ecc1cdb4f74e..a57048243d757 100644 --- a/docs/user/alerting/action-types/index.asciidoc +++ b/docs/user/alerting/action-types/index.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[index-action-type]] === Index action +++++ +Index +++++ The index action type will index a document into {es}. See also the {ref}/indices-create-index.html[create index API]. @@ -8,7 +11,7 @@ The index action type will index a document into {es}. See also the {ref}/indice [[index-connector-configuration]] ==== Connector configuration -Index connectors have the following configuration properties: +Index connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. Index:: The {es} index to be written to. @@ -30,32 +33,24 @@ Execution time field:: This field will be automatically set to the time the ale executionTimeField: somedate -- -[[index-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: - -[cols="2*<"] -|=== - -|`index` -| A string that corresponds to *Index*. - -|`refresh` -| A boolean that corresponds to *Refresh*. Defaults to `false`. - -|`executionTimeField` -| A string that corresponds to *Execution time field*. - -|=== +Config defines information for the action type. +`index`:: A string that corresponds to *Index*. +`refresh`:: A boolean that corresponds to *Refresh*. Defaults to `false`. +`executionTimeField`:: A string that corresponds to *Execution time field*. [float] [[index-action-configuration]] ==== Action configuration -Index actions have the following properties: +Index actions have the following properties. Document:: The document to index in JSON format. +[float] +[[index-action-example]] +==== Example + Example of the index document for Index Threshold alert: [source,text] diff --git a/docs/user/alerting/action-types/jira.asciidoc b/docs/user/alerting/action-types/jira.asciidoc index d37f565c1739b..a1941b4b30283 100644 --- a/docs/user/alerting/action-types/jira.asciidoc +++ b/docs/user/alerting/action-types/jira.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[jira-action-type]] === Jira action +++++ +Jira +++++ The Jira action type uses the https://developer.atlassian.com/cloud/jira/platform/rest/v2/[REST API v2] to create Jira issues. @@ -8,7 +11,7 @@ The Jira action type uses the https://developer.atlassian.com/cloud/jira/platfor [[jira-connector-configuration]] ==== Connector configuration -Jira connectors have the following configuration properties: +Jira connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action. URL:: Jira instance URL. @@ -33,37 +36,21 @@ API token (or password):: Jira API authentication token (or password) for HTTP apiToken: tokenkeystorevalue -- -[[jira-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: +Config defines information for the action type. -[cols="2*<"] -|=== +`apiUrl`:: An address that corresponds to *URL*. +`projectKey`:: A key that corresponds to *Project Key*. -| `apiUrl` -| An address that corresponds to *URL*. +Secrets defines sensitive information for the action type. -| `projectKey` -| A key that corresponds to *Project Key*. - -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -| `email` -| A string that corresponds to *Email*. - -| `apiToken` -| A string that corresponds to *API Token*. Should be stored in the <>. - -|=== +`email`:: A string that corresponds to *Email*. +`apiToken`:: A string that corresponds to *API Token*. Should be stored in the <>. +[float] [[jira-action-configuration]] ==== Action configuration -Jira actions have the following configuration properties: +Jira actions have the following configuration properties. Issue type:: The type of the issue. Priority:: The priority of the incident. @@ -74,6 +61,6 @@ Parent:: The ID or key of the parent issue. Only for `Subtask` issue types. Additional comments:: Additional information for the client, such as how to troubleshoot the issue. [[configuring-jira]] -==== Configuring and testing Jira +==== Configure Jira Jira offers free https://www.atlassian.com/software/jira/free[Instances], which you can use to test incidents. diff --git a/docs/user/alerting/action-types/pagerduty.asciidoc b/docs/user/alerting/action-types/pagerduty.asciidoc index cadf8e0b16a44..f74b5773b3719 100644 --- a/docs/user/alerting/action-types/pagerduty.asciidoc +++ b/docs/user/alerting/action-types/pagerduty.asciidoc @@ -1,49 +1,72 @@ [role="xpack"] [[pagerduty-action-type]] === PagerDuty action +++++ +PagerDuty +++++ The PagerDuty action type uses the https://v2.developer.pagerduty.com/docs/events-api-v2[v2 Events API] to trigger, acknowledge, and resolve PagerDuty alerts. -* <> -* <> -* <> - [float] -[[pagerduty-benefits]] -==== PagerDuty + Elastic integration benefits +[[pagerduty-connector-configuration]] +==== Connector configuration -By integrating PagerDuty with alerts, you can: +PagerDuty connectors have the following configuration properties. -* Route your alerts to the right PagerDuty responder within your team, based on your structure, escalation policies, and workflows. -* Automatically generate incidents of different types and severity based on each alert’s context. -* Tailor the incident data to match your needs by easily passing the alerting context from Kibana to PagerDuty. +Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. +API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <> setting, make sure the hostname is added to the allowed hosts. +Integration Key:: A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key. [float] -[[pagerduty-how-it-works]] -===== How it works +[[Preconfigured-pagerduty-configuration]] +==== Preconfigured action type + +[source,text] +-- + my-pagerduty: + name: preconfigured-pagerduty-action-type + actionTypeId: .pagerduty + config: + apiUrl: https://test.host + secrets: + routingKey: testroutingkey +-- + +Config defines information for the action type. + +`apiURL`:: A URL string that corresponds to *API URL*. -{kib} allows you to create alerts to notify you of a significant move -in your dataset. -You can create alerts for all your Observability, Security, and Elastic Stack use cases. -Alerts will trigger a new incident on the corresponding PagerDuty service. +Secrets defines sensitive information for the action type. + +`routingKey`:: A string that corresponds to *Integration Key*. [float] -===== Requirements +[[pagerduty-action-configuration]] +==== Action configuration -In the `kibana.yml` configuration file, you must add the <>. -This is required to encrypt parameters that must be secured, for example PagerDuty’s integration key. +PagerDuty actions have the following properties. -If you have security enabled: +Severity:: The perceived severity of on the affected system. This can be one of `Critical`, `Error`, `Warning` or `Info`(default). +Event action:: One of `Trigger` (default), `Resolve`, or `Acknowledge`. See https://v2.developer.pagerduty.com/docs/events-api-v2#event-action[event action] for more details. +Dedup Key:: All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution. This value is *optional*, and if not set, defaults to `:`. The maximum length is *255* characters. See https://v2.developer.pagerduty.com/docs/events-api-v2#alert-de-duplication[alert deduplication] for details. +Timestamp:: An *optional* https://v2.developer.pagerduty.com/v2/docs/types#datetime[ISO-8601 format date-time], indicating the time the event was detected or generated. +Component:: An *optional* value indicating the component of the source machine that is responsible for the event, for example `mysql` or `eth0`. +Group:: An *optional* value indicating the logical grouping of components of a service, for example `app-stack`. +Source:: An *optional* value indicating the affected system, preferably a hostname or fully qualified domain name. Defaults to the {kib} saved object id of the action. +Summary:: An *optional* text summary of the event, defaults to `No summary provided`. The maximum length is 1024 characters. +Class:: An *optional* value indicating the class/type of the event, for example `ping failure` or `cpu load`. -* You must have -application privileges to access Metrics, APM, Uptime, or Security. -* If you are using a self-managed deployment with security, you must have -Transport Security Layer (TLS) enabled for communication <>. -Alerts uses API keys to secure background alert checks and actions, -and API keys require {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface]. +For more details on these properties, see https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[PagerDuty v2 event parameters]. -Although not a requirement, to harden the integrations security you might want to -review the <> that are available to you. +[float] +[[pagerduty-benefits]] +==== Configure PagerDuty + +By integrating PagerDuty with alerts, you can: + +* Route your alerts to the right PagerDuty responder within your team, based on your structure, escalation policies, and workflows. +* Automatically generate incidents of different types and severity based on each alert’s context. +* Tailor the incident data to match your needs by easily passing the alerting context from Kibana to PagerDuty. [float] [[pagerduty-support]] @@ -111,80 +134,3 @@ To see the available context variables, click on the *Add alert variable* icon n to each corresponding field. For more details on these parameters, see the <> and the PagerDuty https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[API v2 documentation]. - - -[float] -[[pagerduty-uninstall]] -===== How to uninstall -To remove a PagerDuty connector from an alert, simply remove it -from the *Actions* section of that alert, using the remove (x) icon. -This will disable the integration for the particular alert. - -To delete the connector entirely, open the main menu, then click *Stack Management > Alerts and Actions*. -Select the *Connectors* tab, and then click on the delete icon. -This is an irreversible action and impacts all alerts that use this connector. - - -[float] -[[pagerduty-connector-configuration]] -==== Connector configuration - -PagerDuty connectors have the following configuration properties: - -Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. -API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <> setting, make sure the hostname is added to the allowed hosts. -Integration Key:: A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key. - -[float] -[[Preconfigured-pagerduty-configuration]] -==== Preconfigured action type - -[source,text] --- - my-pagerduty: - name: preconfigured-pagerduty-action-type - actionTypeId: .pagerduty - config: - apiUrl: https://test.host - secrets: - routingKey: testroutingkey --- - -[[pagerduty-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: - -[cols="2*<"] -|=== - -|`apiURL` -| A URL string that corresponds to *API URL*. - -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -|`routingKey` -| A string that corresponds to *Integration Key*. - -|=== - -[float] -[[pagerduty-action-configuration]] -==== Action configuration - -PagerDuty actions have the following properties: - -Severity:: The perceived severity of on the affected system. This can be one of `Critical`, `Error`, `Warning` or `Info`(default). -Event action:: One of `Trigger` (default), `Resolve`, or `Acknowledge`. See https://v2.developer.pagerduty.com/docs/events-api-v2#event-action[event action] for more details. -Dedup Key:: All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution. This value is *optional*, and if not set, defaults to `:`. The maximum length is *255* characters. See https://v2.developer.pagerduty.com/docs/events-api-v2#alert-de-duplication[alert deduplication] for details. -Timestamp:: An *optional* https://v2.developer.pagerduty.com/v2/docs/types#datetime[ISO-8601 format date-time], indicating the time the event was detected or generated. -Component:: An *optional* value indicating the component of the source machine that is responsible for the event, for example `mysql` or `eth0`. -Group:: An *optional* value indicating the logical grouping of components of a service, for example `app-stack`. -Source:: An *optional* value indicating the affected system, preferably a hostname or fully qualified domain name. Defaults to the {kib} saved object id of the action. -Summary:: An *optional* text summary of the event, defaults to `No summary provided`. The maximum length is 1024 characters. -Class:: An *optional* value indicating the class/type of the event, for example `ping failure` or `cpu load`. - -For more details on these properties, see https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[PagerDuty v2 event parameters]. diff --git a/docs/user/alerting/action-types/resilient.asciidoc b/docs/user/alerting/action-types/resilient.asciidoc index feca42a542a2f..296156875ceb6 100644 --- a/docs/user/alerting/action-types/resilient.asciidoc +++ b/docs/user/alerting/action-types/resilient.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[resilient-action-type]] === IBM Resilient action +++++ +IBM Resilient +++++ The IBM Resilient action type uses the https://developer.ibm.com/security/resilient/rest/[RESILIENT REST v2] to create IBM Resilient incidents. @@ -8,7 +11,7 @@ The IBM Resilient action type uses the https://developer.ibm.com/security/resili [[resilient-connector-configuration]] ==== Connector configuration -IBM Resilient connectors have the following configuration properties: +IBM Resilient connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action. URL:: IBM Resilient instance URL. @@ -33,37 +36,21 @@ API key secret:: The authentication key secret for HTTP Basic authentication. apiKeySecret: tokenkeystorevalue -- -[[resilient-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: +Config defines information for the action type. -[cols="2*<"] -|=== +`apiUrl`:: An address that corresponds to *URL*. +`orgId`:: An ID that corresponds to *Organization ID*. -| `apiUrl` -| An address that corresponds to *URL*. +Secrets defines sensitive information for the action type. -| `orgId` -| An ID that corresponds to *Organization ID*. - -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -| `apiKeyId` -| A string that corresponds to *API key ID*. - -| `apiKeySecret` -| A string that corresponds to *API Key secret*. Should be stored in the <>. - -|=== +`apiKeyId`:: A string that corresponds to *API key ID*. +`apiKeySecret`:: A string that corresponds to *API Key secret*. Should be stored in the <>. +[float] [[resilient-action-configuration]] ==== Action configuration -IBM Resilient actions have the following configuration properties: +IBM Resilient actions have the following configuration properties. Incident types:: The type of the incident. Severity code:: The severity of the incident. @@ -72,6 +59,6 @@ Description:: The details about the incident. Additional comments:: Additional information for the client, such as how to troubleshoot the issue. [[configuring-resilient]] -==== Configuring and testing IBM Resilient +==== Configure IBM Resilient IBM Resilient offers https://www.ibm.com/security/intelligent-orchestration/resilient[Instances], which you can use to test incidents. diff --git a/docs/user/alerting/action-types/server-log.asciidoc b/docs/user/alerting/action-types/server-log.asciidoc index 276f64e7786bd..7849a70a239c3 100644 --- a/docs/user/alerting/action-types/server-log.asciidoc +++ b/docs/user/alerting/action-types/server-log.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[server-log-action-type]] === Server log action +++++ +Server log +++++ This action type writes an entry to the {kib} server log. @@ -8,7 +11,7 @@ This action type writes an entry to the {kib} server log. [[server-log-connector-configuration]] ==== Connector configuration -Server log connectors have the following configuration properties: +Server log connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. @@ -27,7 +30,7 @@ Name:: The name of the connector. The name is used to identify a connector [[server-log-action-configuration]] ==== Action configuration -Server log actions have the following properties: +Server log actions have the following properties. Message:: The message to log. Level:: The log level of the message: `trace`, `debug`, `info`, `warn`, `error` or `fatal`. Defaults to `info`. diff --git a/docs/user/alerting/action-types/servicenow.asciidoc b/docs/user/alerting/action-types/servicenow.asciidoc index 4a11a2e28712a..f002c39416f1a 100644 --- a/docs/user/alerting/action-types/servicenow.asciidoc +++ b/docs/user/alerting/action-types/servicenow.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[servicenow-action-type]] === ServiceNow action +++++ +ServiceNow +++++ The ServiceNow action type uses the https://developer.servicenow.com/app.do#!/rest_api_doc?v=orlando&id=c_TableAPI[V2 Table API] to create ServiceNow incidents. @@ -8,7 +11,7 @@ The ServiceNow action type uses the https://developer.servicenow.com/app.do#!/re [[servicenow-connector-configuration]] ==== Connector configuration -ServiceNow connectors have the following configuration properties: +ServiceNow connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action. URL:: ServiceNow instance URL. @@ -31,34 +34,20 @@ Password:: Password for HTTP Basic authentication. password: passwordkeystorevalue -- -[[servicenow-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: +Config defines information for the action type. -[cols="2*<"] -|=== +`apiUrl`:: An address that corresponds to *URL*. -| `apiUrl` -| An address that corresponds to *URL*. +Secrets defines sensitive information for the action type. -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -| `username` -| A string that corresponds to *Username*. - -| `password` -| A string that corresponds to *Password*. Should be stored in the <>. - -|=== +`username`:: A string that corresponds to *Username*. +`password`:: A string that corresponds to *Password*. Should be stored in the <>. +[float] [[servicenow-action-configuration]] ==== Action configuration -ServiceNow actions have the following configuration properties: +ServiceNow actions have the following configuration properties. Urgency:: The extent to which the incident resolution can delay. Severity:: The severity of the incident. @@ -68,6 +57,6 @@ Description:: The details about the incident. Additional comments:: Additional information for the client, such as how to troubleshoot the issue. [[configuring-servicenow]] -==== Configuring and testing ServiceNow +==== Configure ServiceNow ServiceNow offers free https://developer.servicenow.com/dev.do#!/guides/madrid/now-platform/pdi-guide/obtaining-a-pdi[Personal Developer Instances], which you can use to test incidents. diff --git a/docs/user/alerting/action-types/slack.asciidoc b/docs/user/alerting/action-types/slack.asciidoc index 6258969753356..6f7d1b3e11d31 100644 --- a/docs/user/alerting/action-types/slack.asciidoc +++ b/docs/user/alerting/action-types/slack.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[slack-action-type]] === Slack action +++++ +Slack +++++ The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks]. @@ -8,7 +11,7 @@ The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incomin [[slack-connector-configuration]] ==== Connector configuration -Slack connectors have the following configuration properties: +Slack connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <> setting, make sure the hostname is added to the allowed hosts. @@ -26,29 +29,20 @@ Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messa webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' -- -**`secrets`** defines sensitive information for the action type and contains the following properties: +Secrets defines sensitive information for the action type. -[cols="2*<"] -|=== - -| `webhookUrl` -| A string that corresponds to *Webhook URL*. - -|=== +`webhookUrl`:: A string that corresponds to *Webhook URL*. [float] [[slack-action-configuration]] ==== Action configuration -Slack actions have the following properties: +Slack actions have the following properties. Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported. [[configuring-slack]] -==== Configuring Slack Accounts - -You configure the accounts Slack action type can use to communicate with Slack in the -connector form. +==== Configure a Slack account You need a https://api.slack.com/incoming-webhooks[Slack webhook URL] to configure a Slack account. To create a webhook diff --git a/docs/user/alerting/action-types/teams.asciidoc b/docs/user/alerting/action-types/teams.asciidoc index 7f4a29dc86fc5..294b5474e390a 100644 --- a/docs/user/alerting/action-types/teams.asciidoc +++ b/docs/user/alerting/action-types/teams.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[teams-action-type]] === Microsoft Teams action +++++ +Microsoft Teams +++++ The Microsoft Teams action type uses https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook[Incoming Webhooks]. @@ -8,7 +11,7 @@ The Microsoft Teams action type uses https://docs.microsoft.com/en-us/microsoftt [[teams-connector-configuration]] ==== Connector configuration -Microsoft Teams connectors have the following configuration properties: +Microsoft Teams connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. Webhook URL:: The URL of the incoming webhook. See https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook#add-an-incoming-webhook-to-a-teams-channel[Add Incoming Webhooks] for instructions on generating this URL. If you are using the <> setting, make sure the hostname is added to the allowed hosts. @@ -26,28 +29,20 @@ Webhook URL:: The URL of the incoming webhook. See https://docs.microsoft.com/ webhookUrl: 'https://outlook.office.com/webhook/abcd@0123456/IncomingWebhook/abcdefgh/ijklmnopqrstuvwxyz' -- -[[teams-connector-config-properties]] -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -| `webhookUrl` -| A string that corresponds to *Webhook URL*. - -|=== +Secrets defines sensitive information for the action type. +`webhookUrl`:: A string that corresponds to *Webhook URL*. [float] [[teams-action-configuration]] ==== Action configuration -Microsoft Teams actions have the following properties: +Microsoft Teams actions have the following properties. Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported. [[configuring-teams]] -==== Configuring Microsoft Teams Accounts +==== Configure a Microsoft Teams account You need a https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook[Microsoft Teams webhook URL] to configure a Microsoft Teams action. To create a webhook diff --git a/docs/user/alerting/action-types/webhook.asciidoc b/docs/user/alerting/action-types/webhook.asciidoc index efe1077707ef0..381d6e72bf9c0 100644 --- a/docs/user/alerting/action-types/webhook.asciidoc +++ b/docs/user/alerting/action-types/webhook.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[webhook-action-type]] === Webhook action +++++ +Webhook +++++ The Webhook action type uses https://github.com/axios/axios[axios] to send a POST or PUT request to a web service. @@ -8,13 +11,14 @@ The Webhook action type uses https://github.com/axios/axios[axios] to send a POS [[webhook-connector-configuration]] ==== Connector configuration -Webhook connectors have the following configuration properties: +Webhook connectors have the following configuration properties. Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action. URL:: The request URL. If you are using the <> setting, make sure the hostname is added to the allowed hosts. Method:: HTTP request method, either `POST`(default) or `PUT`. Headers:: A set of key-value pairs sent as headers with the request -User:: Username for HTTP basic authentication. +Require authentication:: If true, a username and password for login type authentication must be provided. +Username:: Username for HTTP basic authentication. Password:: Password for HTTP basic authentication. [float] @@ -36,45 +40,23 @@ Password:: Password for HTTP basic authentication. password: passwordkeystorevalue -- -[[webhook-connector-config-properties]] -**`config`** defines the action type specific to the configuration and contains the following properties: +Config defines information for the action type. -[cols="2*<"] -|=== +`url`:: A URL string that corresponds to *URL*. +`method`:: A string that corresponds to *Method*. +`headers`:: A record that corresponds to *Headers*. +`hasAuth`:: A boolean that corresponds to *Requires authentication*. If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`. -|`url` -| A URL string that corresponds to *URL*. - -|`method` -| A string that corresponds to *Method*. - -|`headers` -|A record that corresponds to *Headers*. - -| `hasAuth` -| If `true`, this connector will require values for `user` and `password` inside the secrets configuration. Defaults to `true`. - -|=== - -**`secrets`** defines sensitive information for the action type and contains the following properties: - -[cols="2*<"] -|=== - -|`user` -|A string that corresponds to *User*. Required if `hasAuth` is set to `true`. - -|`password` -|A string that corresponds to *Password*. Should be stored in the <>. Required if `hasAuth` is set to `true`. - -|=== +Secrets defines sensitive information for the action type. +`user`:: A string that corresponds to *User*. Required if `hasAuth` is set to `true`. +`password`:: A string that corresponds to *Password*. Should be stored in the <>. Required if `hasAuth` is set to `true`. [float] [[webhook-action-configuration]] ==== Action configuration -Webhook actions have the following properties: +Webhook actions have the following properties. Body:: A JSON payload sent to the request URL. For example: + diff --git a/docs/user/alerting/alert-types.asciidoc b/docs/user/alerting/alert-types.asciidoc index 5afce8fa6cd93..9eac084bd03c4 100644 --- a/docs/user/alerting/alert-types.asciidoc +++ b/docs/user/alerting/alert-types.asciidoc @@ -10,14 +10,13 @@ Kibana provides two types of alerts: [float] ==== Standard stack alerts -Users require the `all` privilege to access to the *Stack Alerts* feature and create and edit alerts. . -See <> for more information. - {kib} provides two stack alerts: * <> * <> +Users require the `all` privilege to access the *Stack Alerts* feature and create and edit alerts. +See <> for more information. [float] ==== Domain-specific alerts diff --git a/docs/user/alerting/defining-alerts.asciidoc b/docs/user/alerting/defining-alerts.asciidoc index 8c8e25cea407a..27f3a6c7309cb 100644 --- a/docs/user/alerting/defining-alerts.asciidoc +++ b/docs/user/alerting/defining-alerts.asciidoc @@ -5,9 +5,9 @@ {kib} alerts can be created in a variety of apps including <>, <>, <>, <>, <> and from <> UI. While alerting details may differ from app to app, they share a common interface for defining and configuring alerts that this section describes in more detail. [float] -=== Alert flyout +=== Create an alert -When an alert is created in an app, the app will display a flyout panel with three main sections to configure: +When you create an alert, you must define the alert details, conditions, and actions. . <> . <> @@ -19,7 +19,7 @@ image::images/alert-flyout-sections.png[The three sections of an alert definitio [[defining-alerts-general-details]] === General alert details -All alerts share the following four properties in common: +All alerts share the following four properties. [role="screenshot"] image::images/alert-flyout-general-details.png[alt='All alerts have name, tags, check every, and notify properties in common'] @@ -69,6 +69,7 @@ Each action type exposes different properties. For example an email action allow image::images/alert-flyout-action-details.png[UI for defining an email action] [float] +[[defining-alerts-actions-variables]] ==== Action variables Using the https://mustache.github.io/[Mustache] template syntax `{{variable name}}`, you can pass alert values at the time a condition is detected to an action. You can access the list of available variables using the "add variable" button. Although available variables differ by alert type, all alert types pass the following variables: @@ -105,6 +106,6 @@ Actions are not required on alerts. You can run an alert without actions to unde ============================================== [float] -=== Managing alerts +=== Manage alerts To modify an alert after it was created, including muting or disabling it, use the <>. diff --git a/docs/user/alerting/images/slack-copy-webhook-url.png b/docs/user/alerting/images/slack-copy-webhook-url.png index 0acc9488e22a335e31a9e429bcc033425f11baac..805f5719980dabed80af6a8fbaebf194b52305c7 100644 GIT binary patch literal 21738 zcmeFYWmj9_7A;((MuAeSc!A=@Avh^*aRM#w?gWCn6k6O`9D=mCLvV-U?h*)AT!KSz zxVz_^JI4D9-cL7UK(dpJ&E5}d&9&xS^9lK^Acgas?D@TW_i$vSKPlb2_xLUFI^*dB z;J1Ppw+!%f-%&~G!~L1wcfP>EGdpQb$9wmP>Hq!Qmr;6qaPOWSbZ<=A)CRfm+=34@P_OEz5cfr|8E`s8xjA%ufru@adGkFlEePxQ+HqLlqc?l~ z{Gc7L!TzTZ*Y+&&JVB9!I9}bv17GZJPCyuUGkD(c zD1h5V#0054(Fg%^HvQ^3F}cXgOAkg!Z#KOGnWHqH@WpD(u;|7dc}a^Q20arO7dHw% zTT9RvQg=HZe=)YIOsU9sbUSkN?#OPt5jBGb?e&+ z({uH)=nN$i9S|{!`3MVxwA{__@9uz4Mn2jPX_cFV9Bh>9d2%)crJxSye}f_TiWG=v|2;u# z4qgXC3$fjFM+5EHu#Z*s;%=0lOoD87%1Iar$DaETKAZygHNp~EW|+SAb3EO5@4|Dh zd1Es((xt?4QxR{z(lW*||CScyoCW8%NyyC1cfZ5XfK@J){c84$6H+Rn^E1<=%(!gt zuPji?)8nJPW`#h<+*rXw!U^YW`n2}gIzaPdJJV?l9_gzfa|v(!ULo2P=esKRb|>S zeYZaWe&h0eeSK{T7t<}brn%Q!iaxVbQ&Yz&z&cWJ8jYVHuG~z^7^I#rsV9kH1l&>oc7wzyY=HzC4z=-$6e*}VAg}} zjl~}+v9}lX%|p`mS&wl>xp}45?wUr_lQdnoRipiq1NKiv`}GeW_U;XP>sPEq1?{KSJG=p3EW0?=GV# z&qUZkra5$!H~o-o)QOd$67)Ep(r6CWbh&`Dq2Gd8WtAOn@#zn4a8>Xra5h)%Fzw7f zG_Q64n3QU^D5c*Mh_V< z1u{+eqL4rF(P&ij zUX$VjYVTj|<7=a?P8JO0VwwcWbzaG>XZ*=rGB2m>o`V!EKMyhQp5nyu==~Ve@SWmQ z!eh-5W8;6FELxWtI=?(0H-FH2`9~c_<o40u*}!@LnK(T7x1-Fo^bd)OVR4(=s z{vDrAQsCBIRaMoXZ+3R}8=jEBXQ;>OPpP(&ed%W(gK!~lQNa-0C)LOkT~G(|M>LH~ z-#=`XIrb)jXJsao@T|Krn-#u|e-|>i;qn_e_=ls7PRhOteiFm#)o@EzUDO| z-b7$J0BrG=MhyP-^mA)@5{^_k-oNXK2u5tWw{bM>oIf@U+U0TLt%6cIEAAEg(KA3U zD0$lC%>_-TThe$k?2dDmM$N~6Xbbx~ecp%@wL}NhwCzcIvTeLn?@&<24Ewsn59|50uK2E`%4er`s(~sEmE`AzkQS_&uJ@@jp)32rA2&CvM#>_{ z=cC6G8JZJ|I%L$i>$Wx$8x$~(aFeo*Bxjk=uO+?gjr63#Yn%mwv#l|*o<7}bX4bTP zudHJf^6SOtSn!R#T>YwX{v1$Tn()*j=it0xCA4s}h=<{(H99#V z>~$lpkXQZ(-Gchlub5_{q8o|Kn{O)poW%v#L!@<7X8n=2IxS}-vP|Ek4Ia7zG50(3 zwN|s0Is$EDPktt(9(@$$HNFis5V(m6W6$ei$%)1m{qc zgwDDhp0m%Cg?gY)&%&@rV#3aZww%^ZF03Odmxmj}rABl2t~SFa{AfUII<+H*!~f8} zHP&%`fXfnBY;%b&N?`0-(CuKURhf*8jKbS$q0v3WgdEZP_bUnfJO85BxPl;1{uD&6 z_8X9I)tp(XWAqPOQ}oD!FkscFmUn06r`t02ulS2}_BB!Fk=(FGe0X$ro(Gcry0tUs zA4~=Z4o}PNoHv(7#$J~S8)u2U*$Q4AzC2U6ZMxLE(zs(BzE9jgcA?_|ZSt?3(JrZ% z8w=L0-3X|eEwIvZRaGC-`IU;qXy;z}IxQYeW^Y7P74LE)WJ+{=y2F8tT}?Jx43pD5 z8+v}4-r4TNz)HHR$C4vj*ge#%n0@&HdX!a(4vKyPgPb%=3aSUd4tXgSHAD|^NESBN zE^f{HV4hCLBd8OnEl+J$7vUBrb%L{DO#Xw;oLzoVD7c(WU16f*=;P2hRI7!ri~{Nu z?aym|91;py=JcHLIhdg&Ftcqkix#3$`g%(3wWsqNz_itTcic&2K2CbkmW7q&Idnd- zCH$CWm|6YuG$-DMNLzBwW;*66f_Z+5Jr0seof;KmYhztnoX}Tx+&nWm++?fdq6m#n zxl+F;7}ad0Rx;~3-r)a3=_qZh&iF>3uNbBD`9)s{u^wAK2N`1 zNw&dsXK0rnoN^Vib(|6==V61+-UyFZn;IRNIPdH#w;!MIT&!41ZGCs~Z0CSn89tRN z*5*0IsE@cxnilz)otfz@HMzi_AUB8(L9VKX|3YVLYh~-5nj>T)DP2X^?_BP}AY)1@ zEOF}O1t~SL3*K=*|SZV4b-u--6)e!F@cMX`8tvt zKw;Yl@F(G*D?mmue*V1mvch3(d+N(sN0JMhE<$BKEhz4w?{7f^X27@5-B?pfxuUYF zzDE6ZcIomTLD5DZj%bDc;G&Dzp}NCkC1!rosI0Si8rbogD{H`8haIKFM&nx>x0LFJl^o>xw{c z>j=$9Mo98oekHs1<~04cIY^Z+U$}sbygHKiwA1qR^i0t?eS)y;j-(u#Ty;S|3Wh97 zX}PKu3mVpLJniJP&1#=NuYpt0KR_^RzJy=?$Vh&O_7xdiPL%71`SJ?+P5do;#K*B= zrtP+~{;orLY&cbheYtmYW7%Czw2o5?`aB%{CasZ$%s$)!p?ubYoG34*-H=&0c1wtr zQ!mh05p?vssSAZf8mtxz^bB1W_*Bac!KZ9N{JKQvi^!eipAKBl zMXf!eX)JzZp@Irj%k@%P*wk9$^b)KK?`zK3cL<4$9IKGZEq82ywkXsGpMEP%}DZZ0rzs;PKeR@1S2HF`X~%E1ct zjhTo8bW|DcB785l>8y%TA3qP;oCN;lh*CYZR{V2T8jF^OGfPWCt>kUE7v-u5`|a-JME;b@2sNIf^Iso-yL_2X zRX22ixjW`aP{>Lnlv@mjv~`l`La#QYD117AhJP(9zpzkvb?KvgvQ#d(-r&!Jt0Gb! zv-46B7qo`(p!-JJhT`#F!#)*2u_z+mN44V#UvK56->$=9*X9?UKzNOP2pAQv zFLz3BNDjjw{RwQYDnz1@V%wXW-k0AmjyLYEd(xkny^oBRlXKZ$p!5z%(|H?-RH-gT ztG8Uor9y{N1hFczPJrkFD4dII{*Swxec#>xL|9*!=<7w<&&=k>Wx{AZ^8Zh4nK$+l zev_R_b1>C*w$VuTH;TFREGb_S92TTo_h3U^uN!y9XXm84fQ+v1dkDlZPqM}4 zB-Wq#>JzjeaUEiy>DndD_$JtCEC1SyUbt2H7xFEX)IF*Ns%rmox(QQtwx-Cuus{qK zB7-{zB=Bf5e}?wCS4_Q4B9}x7-Q%a?G*I&G^!^=BgCRUbVmS^_PN>LK4}Ai%T<(n+6$?tUFz&}hE`8GDJE)g#!V$jE_i83*<923C1JSnR{T#`N3LVi zZtJT%kIHgi`75emhB!_N4;>*oP7)5-dUoERH(SboMhYiZkX zTHTuRXpFie$NhMHhFMYI_7S7_9T9xYlFM{^QGY8+)UX2FkrP>YE*BkBJ^y3r3e7M#_m;oG4XJBzx!|V2^@qBmAIUH zHoq&sB-Tr?l*r4v@j%6Cq5aUf8wL>3fD9uSmG_3JHVS=E@6THk{F*gTU{JiEQXt(~ zPR!=q1d_tkxy;!=-dEEB9G%?k zq7Se7=iUD*Xd49?DCY9xHPEfW1y)|Nfs(4g3Qr&B>t42Lir#NnnY}qF>|#S#BeQnA zS*TO>IoEE1a#o%%vG*zY2h7)q?WDz6YSXxxK7W|eKG>LojGb(A0Uv86 z#9;V5iUnFGCOAM<(-VU83d^3^GGT@K)v}K%ePN|>pIPHf#z+X<%TcEwl%(RJ(6K!p zaqW2|3v-hHWpb<{$wg6S=HKH}QG{=$@mbfOAM-?)-^B>v1uTUWBsUA5d(LA>p`QHQ zlmco!FZ%@MFA64y&O1|r303^XR~QtGL*VWK;~!Y$?V$ec83$v!S2@Af*7g^5;S2kY z9D(jEPewtKkg443?)}>h*Da^nI%!YOE3OuBS2|KN#UgU1!u*O_e3;`E8^{~bk3I&y zs3OogI+J@~?inz;VH86+N*#IiE%hi;c+YO^L=j=R*li8cyH-5TfC0?B9dxIl1GUnr z`UC&%-DWpWlCzgeUVo!wn++BE=C|8iiGo!XW?Pei#(fR3TF9Ulb-jYwvtw9!X z*eMqrd!J?^@SM6D2IsdXh3kcq42@#EXwPU#NL&#?<59-zZwdBCYgBiCKDr#~{4`$s zSSj2p$E{zqoVao0VGy<|7X0IJjswS=U?NwBI9(HjWseQRkbgvCS{ekp%fmFR%WvnD zr+eb3&NECA*YwwEk^p=1f%{vOXtu|(tHFj!Ek zHAz6MUBc6xnWs`lnwO$u=QYeVYB%VedXwG)1by~KA>wxz!29JM)69!!YZ@SHT=0%bv2q_HQ5aHgmKb zc#HcrpK6z;5n?hKJRQE1dM5SYE>=Dz6@I?n$i$<_hQo%0(Cb!~B^S+^?Nz$>S?X2F}Khwsl89~z@r|rm*7dxsk&Quc<$#VI)r|_{Eq~cEQQtYB%F-O`A)+{lS1~IoJBzh%NQb)p5`( zM{IDfq``d;V&`dfbYDCx<70++E9yg5pgMYQ#ONvrpYmRz0s|jwpSm6RJvnt0HmRjh z6uJHGJ=Kl}hWdJr$uQ0=HUq-)Pz^9sO1h}7tGk%BE~z4Tr&-=1Ci)plW;2pM%!f5lL3yw*=PKK@VNfW{+li}`TL}ajH!!-}m+tbfMQz$$ByAY~WR0&^I zA|4-Y`)mxm>nqe$)N6M^eS5|E5-A7rn;vE}{_i%K`;Oe{IG$fJK9;{OUp5Q#-N}F3 zjl(8tF0ZkXU3gDPLiYS}ft%CiYr2lk!MN1<$3-I5C0RfW*lrD$VCQF=`ieVQpIYbW zO*#hB+0=w7JyjxHt8quoSuyvmGjZ1iO5>O{d>rx+Ki)-Yz)v%|6*)1XT zN1hm=twhxCPQGIkLOd3gpb@RQQ^D!^F0(x%yUT1b~r}ptc0$86W zH7+tm^b~Q&Q1qpHtm^cAKpBV7n|Bzw%bVUMG6bnJR&?$`WmP9^k_`yPB%sYk{^uZ6 zm%`-u9I{hcF_~Lueyg4Q2Kp>bHbr=EsEK1Dh$%|3{3q(3p+QK<=QJ|j zjv1Ukn_zimXihSS|rFRUv@5YrzbAQ zm2*?~MR`OG*A#F?0yi4We<{|KGa)m~Qfrhk+dB48pn;d{TiH_VojeVK+3pRB&pVBD z&+(g2^{Y!toa{Wrg6~Q_NaxnstdJC2t%#v&=PhHlyRl@rdH!{1a;>58b|~X=Rl{`yEtj&hMyzLeEk3y-bX)7Iqz_K~bxGn9v76pz)OlPp zAv{M^VDNCPu&{8jhNJPo|7H@%^ONJ`WHQhB8TSq6XT7VNbTJIh3h%6}tjbq-Z-Ds= zZg{Jx7t$_fz1BFYqQ#+up*Ik05j)p*ca8Byo17^&Eh;PpL;m$7;HNcoNxHxQ4pXB< z=)zP8P&==+zPKTx+pER9ND9HR=AOJSnXg);zauLxMrp4K^>3FGfGOiaf(!2z1R8zC zf>O%~ifs?$Xcn+v{=`hMA;e=obaJQT3s9fLA0<-tjHDH!tl(6&<2G^za34<0da7fG zp@{>651S!=uWPkKgGQ*Ww{@xb)8?i{Y5sVvhn_Ij?qtn%%3M{e7*SG#8sT1 z{>rLEh%!-}TOCydXJzf7^0$f-6CAmYoGOY5g5cXMwE7Iu?j?&DvlwwEDwtJoBo7C~= zLP8U)Q_jBiOuat8d=U8n4OXoPuCCx|dI#F|zRFZ_Ijd|XZ3e(#&eFL?WWHlN8_vHj zq?Bp8b?^!ZdHnL;C$f#|Hb*Jboe-4nxCG%M1@D#oxd~3hKOOQ zQu6_6E&gv6_2O(yD3Pw;viBw&I;OYy>;67pW!((r95o$t4Y}_0$JqcIJf?{Bgq-q% z?{_xwPUq`7#(sI~meq+)rSY?b7W$+a!d|C-$~1m?6rtS5m72TShXJ_dlCLIfRrENI zu7&jJKsMx#=}vTG_hq{?QY#WwqaB%_lfJ2>&7Wj6`#Q9ZGqI#qy+1ZBA^GVuLME+Q z&!u}l%00$@%o6ro26Hj%=}d}{d5l%{xGCxD1;YvnJaqRU;-0yhOql2|j<3$!@#10h zMCFz|<)hS*$}80oYx zPStT12pN4&)Sl!Utr!5ZGP*p@<}kSV@%dRjv0Z9Xx#|UG?*jqkX1We5CZ9<8?;->sjsh`LJ9F$XOh*47?tRY z4@f*n_ow#mxKW3)=<08~Z2{9?o<&?{QX?_&EnYW@aaQ(^I9RAhzQz&&6D&f(e^ctA zWKeNf^(io^f3j}X9*E<@?dd2a1?7$@rpN(v&;N`;!zdB?jg51@SatZq5t;6~_7_B$ z8en>EZUD;CNFh~%gKT6mw1!5?mX=$?xHm}`Iwc2(-PBL?z{vn{Z)UU;PY_cY#DyMO$Z;lGOGNgj2;}sM0+lyn6#Q5Pvw3M5`1O?5{ zXhdOAx{W5uv{gLe{(f(4s|m(Nk~`}&O&HPD`J!TyLgmjP?VCqUNgM^Oo#LueraO6_ zUL@NiHPo0FyE@RYYlRJv*;uHkW-mUxv95MT-DPL!HR*Xq4jhZ>AtFg>hP1I$@+-?b zpbx!dx4l^^r2N*}L!jG{bDcw@^lat3n_UOPaq_e$-E2GOkIvP%x0%DFkG=&;Tke=n zQV|7x8lX%Ks-i;~q;ir5`VWdbQ<(pTyauL6g*JbleOi+t(sW#WmR)M3JoL2r)`!P_ zfCH4zL1}TB7={|3uvrd<)bSsG3!GrP;GIG7DyZCCv3jesyk}=Wmr1Bmt>Z|)`4k3W zVMnD&>izCNZ6}M(x{h2*QnT-1i0Psj!%_vGc_348gDeotmz!zGEIi$7ubB76E-==b zqTDQPDe^FI44@RiPjk-aPs-S_U!A?D$nxh$dK$%?*N~Bjyd!4;g#_iyV9fAkB`9Nc zgD0xYc}k!2&bmsThKbWVl&~-7^}321!dz*S;fH?YV%p|r;j&wn>s7`z387Bf(CD8= z$|1S7ZajhI{I8inq>#Qe;$i}ulr05WTigC$b1Dp5r7Gr?)2z%@VG9W*dQUVrkRsO# zo+gCT>dpk_vmXE$8}=pF$S53j)cp6P`JADU$Y9Hx^& z(6oC#4c_#(ZH{Ns*>}x#=;gHNq$)I;)vdQ&@XLmdM;j%9`BsS4!s}gzGcAjemv`v4 zxeuMJ42g;=&^|2vbg^NDchkd@8D5JE%pjQn&FFFQfdP&dq>59};!pT9_HVV14+ls? zr{x`H&DeF+8&!L)2J!^6j@2Am9InfBg62kPs2@M>;a~#E{I$q-Ugf-D$%TuIYD%cm zIIF!0#AgHbe$7~v#AC%bQvPD>O)_Tb?3*R?SnNTSfus0k!yZvyRUSI<2^uX!C4c>W zj`#SMxAjg2aw&?M9QLHsisVHa}5*ubM2YHtBy$2?Dw>y7=-jE``OSw1k9&#-X0*w$)V) zadRW*OxUAPh{F}8(|1DksNK5Iq%#P)uS+W>=cfLnVm z>_%bF*?#&BmJr?aPDg{JfI_^E&Ok*;2!SUD35l0M2v-ATD2v@O@x-02GV*vCC5SCn z`e}2_=?Vuf4%Mj|+Rdk^M!vfxYi6r{+SrNJ z_dD|=$sE=Y=NMG@k5dG4RmM1;V3P#i2q`K@A+8p63wz4f`bMboe<4kBQiEjJMC%|N zBa$wDf#*%PSlC}ySNyv}c4C3*Ytz^R?=p(T&8NyotB^$0j3pV&Rkn_=1VhGGGy! z2HHIz$huCMQ)oBe>1g7;e=b7bujJUM`9kx~3mD|?d#|*6_p9&w94#(9s28W_er+kN z1nGeD5omG=Su1>gwB}FQyp6v=_$&-l|2QAK&KXt2#4{WWF=J9mm2MEITf2wojUHg3 zO34J9n7F1Un2Q)P`|4)w6)7LbzcEdqou&Ms0PPbEE-|w9A(!Q0>?elH2b#8yF#`XL z`q95(`T0B*tNN)M&9{ov$!RkN3qFFdSwQoIrA1C*P; z*Nuk_2PG1~{iho8mo19`1(Ouw2u$6x%73R$^hGzwnUaJivu+;zZMxWGdDQ&TFh zFw3C4;5Q^Bb0l>$pH=)^*=L@X%MRXloAp~&rL>t*ZC&*aeiYt-zee<8^F{ONtlkY3 zJc8@79Sofwn1{z|2M1eQD3?*~HNvVr=x(KZ0piVkys5zwn1Vbx@~n#pjYf^t=B0G_ zo?IkB=-0(}lpvn0u57$5_%AC2gL6$X#6tpfZ_pWKx8{ifqM*Z^YHwpIsk(&mDK(_byVDdbj28inucd zZL#k!U?w%4WW#p9=hZF=-g8%hMmOuSSDg*6Esw#G7tsUz)Uzki$k;G!DpD@l&KzKr zhk(s&*So4oi!R!q8E?Pp-$m_{^Gg2S`e(Aq3xH9jyK}s%6@1T7UYArnr^MpqqAS3# zlJDZp&<6$DaCwlOwk$uMr42SAoO?!NG`~nEZ=A*XG?XN;myzH#{+~U$?7$t8-d3u@(L& z9UV-)ZQiIUTf0oeH}{~NCV{!8^@rn!P3*JfHJTF!vDJ(z+6HmytA(4qh8NEo?!Ew$ z|MkvISacS?ps^nvh|jB>A-&a;ndo&zJ~^ci02WSI`Y!J&meVIv5Xor-_`M5uU1;M> zhrlU<)c)~v_xvH$7*f@W4TN*^k;hg?C&7K-VcHgEq%R+n6W9$dMI+Ef0~9Qw1_GgWb=+WcAxi5U-jqP-dT<*Jy63)z+ULT zAd~8aLnw_iWPx5UUp*jcB8e7z&OK~zL~qdm^~)%3JKd0~{PAd6rtHo=j=*NJ*nG57 zz@{g<=|KYOFiWW4V?pGkdUhHdj9aE#Mzw8%Xf4(NU_TYnvKQW_{eYPTlpnTyW1a>3 zW9%A|9+N@U6f$GdtcpDrxj_VUCX-g+r zgQ2CoT<#R3CuTk^CbGvK_PHLQc3oQMnxB^!sg0DyyvkW{SvGoUMC*jI$3EB~*QsKaED|1$}#pkZGr}G;8Z%AkdK^PgdyT6#E^K#A4db zvu$BDs?duer#tw-U>Y{ja-`sK+XVA{Tdd&$V>VH37*Jv0sFjaT(ZzqoqVd=pvai2R zklW4=(?tK+P%;9n2F-v`B_&=pHffp}v}TS|dN*EGfGJ2v14TDJ!ze~{9%$`l((`wS zO)L4R3s_5NkS`eC*Mde+I4Ub^+!d{F*+BjM|Cz9g-{>DEVPA0OsA z7Tzs6y1%bi84QMy4ZdHA3_GpDbo6JR=7S3S+E4vvf6u(YitsW|D}oPSzqBN--a$*l zgc1WPv2gr8s~$LGE@QAvsm>>{dtRW1p`^tX4nTmxS#> z#>GfYqD)b+naUs!;w>t#abluX{bCeT?@#0Ktu9tbt81pL1{X1!Yw*OCmj_O!Rx*s0 zaoaE8JMiT$6{F;5ULIq_vga$AskQlc7l&G`Ki@!fBB7qa>Ko)2G8QGUHSmRtCj~xp zGS*P{WB2cx{<}j*rHM>DBKW(0!2QTlB4}c%Q)PH{9yCBjpH?imC+{n6;8P!Y5w4Ds6CXFN&GpCIUpI%$fX8wGQ7VUx7vw__EiOc7|ER7fwR6ocA z{)D_dXLCkG(ojCEb0?u#b}fKN*LsD?NC>N4kAsv6WIEuZ@iWIAF!j~dE}2KMzx?x7 z8ro;#Y;r?04$gvWpAsC#J3n(^=LzOkAeVkIlgt) zmlcNrUuq{HI6I{Bge>OSssp&b!~U*Hx>dzPDd#4083Q8PQ0@vj73xvTVu0HUziiNl z_9g1=)&4FfT38;L`+g|?F{LU4-zer;-yTG&Zy6x9+v~|2j-`b=R00p{^KkWF!EO4p zK0Jb|cN-$3rvz|d)zUc*2*k!OaV9s($E-Y!> zzSv0Hr+pc|N&C|4=5)IHE1%s`YXFzVQ98X#S=PBxOa)CUC01jQ(RdKGkA<&o{L9D7 z@0eoBA^#~!IRuel!)tK2zTGVrCI~EiV(uqCvSRQgB*FM#>5u(TviQ;U zk_1uh<2HGBdz^>yqonY$aPxxE?`$haQ?^d2UC?gm(Tg3lNWfsiJQa_X(lVBJxl(DpOrJ{t~07P;Zu*E@leJ)Cz7<}d}Wc28||GgzTr+RuzhX4JQpy~7!W=p7<$V0W&B$ zbpp@+aeuw1sv?Ofx&h4|f{J!nVZrF~5zJRJ7P-oQ3ywT>W{QQ1(u#9v(fo?Wk_Tx(T_SLCgq*egc! zgVV@%cp#JrnS>%)$jFR**F7X)rBhLp#kiE7(f)Zdnc?5RSuPn&+4U!9d}>hJLz4c` zwO=9xGPbg1BV;Nf>WB2JT_Tm`B+b`_)Y`(cpv-DJtxBmZFYT`#(DvXd$u77OiO z>PqBE*A7fz_Pg6{wbD|0dAk7#GR9zpCDRd%0s&L8c5SHz+wo z%E5vtA-tflaCbOrzg{uDeXh=Nw}XG)N!g#|g8l9Lb6{_a@Nxk@W@97G(UxCUyViI6 z2IGu-v-SHH%O3Y=CpXn2*?S7Gn%|m?8Yu&=B!YT9mc*Hpk-t~$pso7ft#%4NEar`g zeH`6S>Dr!i{jq+&caeH1pDsEZkTjD!|1o#O)5UR>cYQ9(O6Q=&vk6N{#cv<*G_<|t z+t=2T|9bE@?F&^SJ6+4ocTwlXnTR2`C?oBT@QY}flGcY`SOtlw^m2b8vxp0P)8BC9 znfvsn+4Lr56L7h%l|B3}r#jlBY*f;z-$y9r3EG~4+&JqnwuI)g175R|E6 z7K~Yh|BP%AR7d$TWsj?V$l-O-hi-3Eco^;Hs6t1#qDYbgL-J@#YbG3 z7|Bl}A-1+=&l4BL``pHfbFzw5TbGrr@X)TsO^~_rigyq@Ao`hOI9w`ndO1K_N^>eM zIg))ORN7o|$~q^->Wiqg*UnMfPqBn)qarH{+=ikv-is`9lWPyA^}aHdcFIzH?nKK) zGWmCBlg@PSkpa6bpf0&bB2DygliqiR1VfUpW#7Y&JJ^JIXMgz?E(0#??LgU3V3Nv5 z{Wuh&_p#@3)077hW3{nG5bRNcxL(RBFej~2MDebITGn#d+7@NZyo_SP={&B4L`RSk zmlo9#&5GOKYSfKi0`2W!AZ6^Vr0*y)gEXQcoe~QaSBtF@_6lA}mgV)O@cO^u|6wL# z;q6)Qt`yWm8vuxJo4st(nd4(my@GQR^4vze^Y6Y9!&4+29gx^NDQ^}*F?*>d>84Vr zRCYc0GKXH5)LoJZ-{e5xp@UZP08c3Aw^({}g`xr~27VB=q1YX;tH_E~6ZdQ$*q(~- zDPurO@{ADv-TMkd={+%uQ6HyHqH?);nnL8|Fz18X9nBSBeYEDbe8_m+o6*Ve_Zyy= zT?qk`miO5W34EgK`P|NQ6j|6pVYS^ex`F4G#d&IS{q8Vgt}98R%V3$S;)ViiJGBq-wl`wTAQFI4J*admwk0~sbRv_P3)k+4LW2VE!dM)CxCR;N3vHySk;6@nq_L$8BVtP$@Z3 z?HgjS31|8K!$NYxr?;sm`@3e^oAXfN7S@-^von+IBqZ1VJdA(6#jUUFwu2AI3T^Ibl)mA_wr1 z*yieWKbs?F0BzZ7>KSYuy!Pz{3VrQTH_mBG1BL)FOx8FIZz^>Zc`TZ>dZ z)Y~1eavQ6&m^+u|X!8PnK^Vyin{(guyV4Gz=~CN?TX{78f&k9l8Gh=(fpujFzj*_a z!5X=B1h(DupT^Vh6glJmnI#Akh7J0T7>&C&Pby((#C(yOh3cia!aK`h?3i5N&EG+2 zUclZ`i1g|rgj0Dfi3`ur`?hr4Rs-fYy4Y)AJdNAf25bUZd4$w!hPs!NJR^XA2Py&T z)~c1}p{$(TLtk3|Qos;1p{(FsQeifjTy}DLdOGyj1#mroS_;nsyux-XIQ&AV|Mr#K znk>2^m}`1Ff6=(i{c-XPy53rxnLs{T$S(S#<53A<#o(Reij+^fR$X#P7)?_FSUT5f z959^NUl#(-VoJhx&?@G|FLXaGm+wP z3gx~U3aB-#wq|WFfR<9GRaZ>OQFavKKmR1`Gq_Ai}m3%E59(yhT{dsYq@3T zKwlQGVKi{bwnqh^?;E>W75;%kggPmCN(~p>1$)bZP{;?944qO3PbF2O4IBo-NjR$ zX6B&?|056g6S(>ye74M)7u#3~Napgp?3tKANp8Ihfz}tf98pSxI*RQ$i+RFYP^+2d zLWfH)MtOM#@)8XkBaXaJw;yaEnOlON!UK%*uemn0p|VJ zE);ddy!-~5g`p74cx?Aip7zzp4eTj+1aJ{mda(M0ZJ>nnIfF_}P2ltx*J)gCLK452 zQ;BgFQ)z#BeC=f?gCl--3J)ABs7W`Nfc2wi4v6KnYd@i?I`@4XB zG;nw-Qu|*@tD45epn-a*b1Y zFM^1cgs?%j{)?{kzH_9x?n+AzsaUo)A)^{Q(|Xa1A3``9U9Y$JAHrrD*<=EW^n1EH z--T3ImGZE=nKb?#TJ0op+rx5m0k7}YC?xpk_s@`HynG~%1Ix!8ySIbc)d|98wDn{7 znmcJ-L%BXfUmZ&X#j8w{K$_H-k{T<1_6-doK^~#!t!o5k+ngy!0r09(UZYl-l9Pkd z^>HG}WO>tHDn9pH%oeJR3ArE>&!?jaVQR99Y&_LC^dW(HJ4J zDxffr4}Yi6O2nZcTN0AWIX6+*DxJRTjFS^Di*Iw@FJMW=VwzL0K+Loair8S#O+RB| z9D3#3dh7yJLXGrlM4@Z58tU4!hPrvjXpC*LFer4uztT>`R z{v85N#_P~7cb*U>!V_b)u{%>Pb;D+>Xj!x2vK5r5GobCp{W&DAwU!*y2wyr-r&-!_wYY94b$`Ra}n3++4>B zHz}0zn-rD~n*L8aXZ{cM`uFi{r{qWory^yWBqU{D&N-1?Suz-dCJdSEvd;)bC`5K~ z>{}SwnUR{YXY5SF$kNCbq9Kg=UhZ?>f5rX%ZGM<}eCE17pU?GPUhmg4E^TSOcTno6 z2;8jq!=_tmx31{`o$pR2?9`d8{@#xFDl;w-w;U&F@%1f(zt@%%-Oo$6`*zYdnb(ts ziX18B4_mVF&e0Q(tMHBBFl_!yfzOybg?YTc$grd+u6u059RelUNEDRgqr25obE*PC zxc>g*(_6LY)>#W+mj50Jj*>FmCl;%?P!G>!74r1p_|z2wbJAi>K4%%2t=!FW|DjcM z@u*a>SY5gmDt3lB}ffnf=W3N4`86&ww!E&HSCclF$XTuK_0B zp#8zTwDXMzE*f(tgrI-Uw^GRB+EoaxW@d0*6x&0X*g?B@#_>L_@%;5LOlIfxCPTfHB! zZKfxWet=DO0mEu(_C95y`#{~Y-yAx*FQbP#=hYn!$qgKCPI|`-ZOC!i$cPlNDFnyP zgaamQ+y+UWu@4<09+_E|s&Vws|7dHDnr;oKuTOIFHS5<+N(3FQd7|ARO*?Nw*gTao zvpn%+X3QOpS%N}ASAXVBci>c-?@9=Wg(vt9XhE)ifr7!FK#-Q_xZ7_}#AP2}25Au0 zkQk#v)6#A{|8)bt9s}MG2j4z%x|PKb%-ItlzhxciyXG>*qe;LkhxwHVAQJe2)L&)k zXnj|K=5$~|>{WHTJod?uwdc{n63o_lu=_gwnDCS3o7X$LrmTuXIOM2LlOFiYe+LHT z26h|{-$7yR_i-b*3XV)MmBg)4y#x8msko-hz5D9|fl{qrw`1WZqWjjs0*8$?&a=?Y z`Pl9q70Sg=FzhCiZT%JNg*1dx&puNw3IG;m&1txE$TK$YfpQNN? z7X1eLac=JmFD8+PX;ra-VQPvWvZ27^d_z0@;dK&X^#Xp&$_Mo4FI%pg9O(6MfT@+;GwE?XT5h1x?!YTq?4Xd7SkM8cof zU6hxLpJuPaGJmzace4O}qKws0$(-H!DcT#3b#{9lJMRLH1=!cb_p&{!($~r=x5UY* zr>un0m|WBiM$E@3;abonGPd(V9^XFUgGdgN!!#LRDGU_3ep2N_bVrEsuW&0`B7S1# z$@u_8E-QlGx^&;lA<48 z+0=X8>y%brW?r+IkJ(G3jp6pOy&VJhwcX!U4rjP{T(Fx|*WFShYaQ@I6-AcHZMa&j zgWtHQ^=O-rF5+Sr2G8F2h3mvjO01P`w_#yb>DE6djh;3_2MTgtDMu?`g(!6H9Rfib zcAHutY2n53OvRac7=|Be0D}hmg!?|EwL|pG>_O<&TVk&NDdmV7np?ZwH(&goczAfTPOWwUbB~w5O zw^+{#COfAw<`&y82Xbiw`}a-vapBOxj>i$eC4OX|l~5H9n|AGamHguV$7jDV`HMo} zW=2UeZ4i*eTv)S@^W+F;K~WKr_wAf8+o`iP-t(O`?x3=Wa<6V4Z?0AJ9FSKM&|p>W zj=L2#IqFNW^Ef~h>?ZDO?TH0PLO@R7N({+HXC`?GS<hb5;y(GcIPc3f=h<0hBZG<$9dU@yy=*>o z#0ob7nVM}0!otsN-MP1tV?{ARSH^uo&?Q34(1$NT$t=eDhXG04-$2-Q-G3#Y$F`-Y zT31}aes8k(th^-&zKVPE;=7F6Fd_{~g4qGBL?Q-#)Bb z+FGXC^CI1X%wj^MHM4$iy(y2A`Dm!4Y1~-f$3F$;fb31F`x3P8`C)N&wP7;m!(xv$ zHK5`*rsn6EQj@&ZRgngLq33<9F1pe?1)w*pQ78S6&s zZ6D6pBwmv5@}u;xJZdWwjWpDNYUt>HBBEM$ILq{}ry6t#ToQkr{D%mdl%$vEf7`eg zB+Y`68dp0J^214~tSN{8c#l0x4-svg7&pR#smr@+7`J_diX=7Pzv9WYdaNP@)V(tf z3oK)8wK~t@dzZGH>s}8ud^v`s$_UZf-+im>{C3Tnp^FOk+bei^3%z?k+UPK!v{gYv z(UJ1LEbci+xy}1aAV3Q(qUZHq-r8P<; z$wuhcyIUA5dwUN)z^Ab=*FjnQ51UA{okX-dZE0#TrW>O0bJhr#BE;xX&>a$Bn-ekV5&v71!f3)+qdYB^f0w&)fdE^%skv0HK&IYZ>W4l4o$e zWjp<(&J`{s%!{Z`e)$q`2+YY};)gi*<0d6kj3xzTZO<%LGTU}U_bY+cPdsSep@yyh zm`xK^|7NXjH`;MrL}RzV18AYZM7@=ZAQay^rL`~)^LTyd-1+le38ENqhqGk5p_qNj zjMo0@yP6r3yQn?6RtHLdhN3)f!5l{4+YA@Y4eHDQiHMB`V>qbe=9o zhiS9l(y+?eEei_^U()nW_TyzYG{<84jHu#a?)-!AK~T`L0(nWFO)o^U*x{0r>h>L( zBVf~)aIqY@cHd{`-~hBB-8%aOjMAQr4^O?wAoRP-R!=pC)(Z{Kt|j=)e*7(URQ9>; zK;)#~MYDGsIPm^}8v;{( z_xn78`2avLR(?-L%N7eB=hW0x54%e_ zrhUzQsj{#}4|w{OI#E|w*WK-rJB=tZANJ|YVRJXyaRwh|P6IY_hZeuGGp!=FE5}>_ zc3{|!LfP5>u!{Hwu{r_P_?{)9QIc$sGnC2pfCSOkR@kD;*}Ldz*@w(+M8uVx&N?NL zJv5M z`~-skPfTHb{XJV$P*C#$Wa!lKqrVAQd@KaGK*>Ej=&yt$(i#B00e^_4XF0&MEv_v6 z`<*Y*kxiv@rRBpCRTVS2x`5@@UP}F6)Yl*nr)4Joi0`&o*U(@Eg}S$S{rjtMEj>F+ zZ%anS;_v^*7&~?>@sIz0KH8rD?!&(i$^VaiU}|S`E5Y_c{?0#IwSlgwPSxLz5&r>m CHZpVo literal 42332 zcmeFYWmp}-mNtq*aCawIaCi6M5D4xYcXti$0fM``y9al7ciFfGzdL7U&dhzj@7!m8 z+@GhP?%lP!q`OvCziX|xR);GoNFl-F!-Ii=A<0OKtAK&Q+Jn-0a4?|X8U~#+Ffc?Z z3o$Vz88IpFPaij5HlMm$AG^&apA<*d z)A7KZ%RE#pkjoH+t3E4Y;}DPIr~e!!7XXJNg@j>-kR#S-1Pl#Ig44V``i-^|OyiHL z;ZQD3-F~RuL5cE^fPKc^bq>hLM!5C`yE5wf_6rtlhTyca_)sRvoxdN3HHEZag>v%S zo)M+O_dWO|c~L^x-Au4J3;ry646t*m60?I_HnP|UhA>@9h*~HxBG!IzZ!|?P2dI8A zM<;4JmIg@VldWr$_aHVO|Ae72!k$yDZ=%R(V}(2&79VDO@6G#%G|$G%y&@PR|yPnPi9z9fnu*B^hzsYQ7RG&QIzuSfXoc4mDqTq*^pG34Rg9E8g<*2WKo#vp&evxwGujU#o-W@ z>G1De_J=wh55LZ3(fAaC%HAZ8ydQ8#QwoBLN!@7u@}i&kYO|$iNC+16BZYC%%c_Xl z=@UO&o(`-Qdh|NrZ!OJcXhaJrU>*LTyH`g|AHCh<=yDe()`_$9<=0BXNza+YP@LM0 zj!-)a!ttl+0Vnf^#n2(7WV=HAhWfS2)CyQ~w|yDN8g1fm{UHTfL;?Gvv(A9*h#S56nyyr-=YD zp2zwaBo1Z#=)COY!Z|w`M9L6UiZDZQsdXrnp0_I+ccj2Rq{l&@=lVBOMfb1f6#V2m z)D0N6is(2az9pg1l0mMxWOAxb&yO5?u5k;HD1&cgLi>ZMEuZXrrFx{T`B4WS{Iz1J zoB;Pijvx6Umu*$G`7J6+qoiL^2X>?sZK!Qx!Lb2~-IsB^OLqZXjxeUaQBzMJr;>R=yJ0_#gzcT;j^~Ap*Oj0L#dn`aXQKz^mgy2KHq-z%G%68FsM; zd~pwkKY#=dBG&*j4Ez%*wA>F}?B08NNY!3MW}HNS)*8eLm?Q(pWyGc+T>~a_sL&n< zdwdALybyhIBh%JDA?-yl|Ic;^YbDig$r_#_%kW+?g#YEio~ADLX8&?|6fJgLZ>;!{*2& zk!&P;UD&S#m1vPzn8=W5I!gH!wlKL&suGxFZ`ICIXcN^!P%4rKx77zb##D3tq=62MY{M+lS65?dSW5HVvY z%wEH_jc2;sMNZEF08p z8N6@L_Ikl?u}H{g%I(P&r`vLNny(t0+G5*MacEn){;n9yupl{owWB4$mmdVC2c4%$hVha+$OdgA?-(kq((hY&{WmGHl;(pKs+S z93{l(XfQY5n@;Yt4k<*|7CalTsjecf;;GWsxkO$f5wvulxjNjb-pE-0W2)X$O5;9~S3r);Gtk2)c56HUD%GBf3v(Q`61;>-7%727~UOV|q7H}<3R%le@DcmPuu*6JDbe-IuM z)-#ab&L;(uicBx&m|07?VtY})0BWpi=>G^`dBrf9Q5|W(VWShP;LqZhk)+{j;XRX% zf1ziqV65OzRsBNCLF-~=In^@lP(I`m z^@yv_`aTHt@(CJaQl33Eh3)$4bEZs(%*!mC#fSyptl+JYJ4Z*Bv#qC#Cs%f#exDy1 z9C`)1GyGdH-H$2OS2lGM{;9huozxXtc+8~8wthl~!ar*2;)@{_k1H%IYjrP5U zemc!LqI|uhT=|)hFhPwYXPdw)D_d}`>RnusHOmm0Xp=;7^XaCDAF{=;yTo2;{5$_R z%5e4Q2Q!DoX%|E%giP;%g~A-Ryq7wz`X8XPH?N=P7~&Y7lNo=;NLH%_HY=Tv`j|Cv zWuTt#@W<4OU@|Y4*9D10l>}YH=A>-al8&`HfAOE|*Q+NN%2mp`pXms%*wz|hOqfj8 zy8B(`=XuqIfwQ-OD!>6C8|M}$`vdTY39I{#VMJrLZQkkR8PE^-3E=t#%ed7gYA3N1 zF+?X-ZLKk&rPg+OekxNwl@v>}RTI)CSzFXeUY2K3Ik5_`68awTrTRPc_wy>wO1*Dy zzL^FaN%tZ^AXkbF&DxbkzWZLK{7yQ)<(cIu7Y5gnoo^eZ#aOC-r(flUWnH5+Fxlp( z&H371Q+CCDS>=Xdo3RCvR&fb%oyYg+K$omN?Ns-a>)iB$aSif;=Hc~8d)1EXLGr?8 z<*2jTxBLA46fz335J|ePA>=|*+1N|>GOTvmTN=u%;N7E5C_RcA5hs7g9o)V2 zb$nNTu#{JfOsosh6#sh*KxJ$L!&p&=kLSnkJ2sEkl(rOqqWd0^Zw3&)OGBI z;GvN3wfOtKlhn29^W2RY_LOCIyMWL<-lE6Tl!KpZM_kwO`Ijfz%j(l)WTwXtqPxd| zi`osMYLn_`Jtkk{SJSmMG&^liBQN5PF`uQEuDhV?&~uVbp{%FG*Aval`Kf{_EPcXm zcE9LX&uXUTYQ@on>u=iNh{)^|kp4?++k#}!V1s}bKip!$qf#j4Ylh>?G~`AEf?m?I?)R!))st^E&MAyJX(SKrdq$uu?pKrn;`K zO&1>@{iYrhJ4k!$h-dFoOmcn#YebbipkyG=HtZ8uQi?w@@JO*2Om)3Lw1H-2L zdw|QRe7*t$1JAPfrs1q1FUMECt@jqF^U1<1+&-sqp(e>^9^-QvIRWb5>w-2!!x>2D4b3nMerKidXX z<^Ow?SINR1V67o;VFR#r0^LK9g@>7){~s0pkF5W`<^QOv`9G?1vi{GS|0Cx=Yw|Pw z?ZN-((SL~RA6G&05`^bx`lsv#;c;zdKtl#bXd$ln4RnV1J2s$A8FbM6=NXj#R^_2j z$p{7}3??Hk^35ImEE6^bYhX4cGQ(+-Ck675zS}^A}lYAoIJuGN*Pn4mk>>& zHv>z#$!W9t zd9B$lS-|UI-$+&`>0eu+q}Tz!gAruI(J2dbS{+rItXDK5FP3g;wl9{FV__BlYlhY^ zeX7u?6$NG2F`)#!P=TY9{$KY12$>wYR92OI$!N%%b=qy>xa1^iiT`RPZVRfyUAshy zj8?y^Bk_yc*9c77pIhw*4>JGCPR{8;U+(m3wq9$J=d@j?@p`;Sf>i4-^w&19bI9WU zFH>1q;S;IN&1e!G^sY^#7ZeWlKPv?Q#(v=`cEe+RA+%2t)6@MIT?R*ACV?XzHtGvOqGHpl)M|VP6;t?w zOS?@K6@l>cpCBhp70}SYzEW=%J71xhV3FXV`Y&zk9zjxn=h3lbrsTgv18VoN7j1uw zk#_r#WNn%u*2^YCE`xi9?c3My+o!E6botH7?V3hr@G5SC4-MCPwU-X(r zO^YoKd;IICU0d^l81~toH?$r*!8qhl)1m7kuq2=RLQ#@E?@uL)h6t7$t&$N5xs|#y z?h4PAYsJ#oEy%?}5aY#A_}Dkg;-8N9ae;EL)_Eo-CgMf<9tTOYFEN|(*B$shU6S40 ztM#pDu~Bi6OkK-=J9a*0%jEZVpKP{3yCp9ZQEGPZ=DiQfjH_C5xz88~#?hsrkczpJ z8>^0YwOJd9z@p<%zw~u-YuyPU;Gf%#_U3!iKAFjvnm77*Iu%kW{F+p9@?F;>NiLm} z!Lp4n*Zq1|rAbGVR==vl!}e;t!D3GGbg>f1h|L>yblzed8=3ae6NDoD@^GGCXp_QP9$-?{lA|<8;rVJSP8UV`<>bk;TAoJfby|CvlJ$$@r7F`7ZAH9yp{! z1YtWzC7=JxV|RqQK($ywd5$OGFB~9$2KkRD1?3}7WdEG;|L?@I{wJlLi9Nc|k|kp; zB8qbL${Xue=aX4hn`d?rX9IFq-=kY-3&%GYa2!!v^2OW5tef|jOE2t7joLh6!l0a_ zB}s6u>hKV|SO{D0bPXr_Ew}SkwdeawoHktObtU!;kSD4H2B*}+0EUxVEd4KJ8FvGc z_F*68=~{Dj6bYB0<=Ea(EY6)O{uJtp`|oRNxPF7~`?k*HyVHd+As$QbsVo7E#O9L`g1IUHJn}v04 zv*`Z|QvUhg{zpPM;_rx};84*soZTN~}Iklj$aHRdR zi>~~8b-H zN2B?|SCs;tlW#oq#6#e620)T}N@Ml3Z`>~?v?^WW;NC_29RH1T(hLxM$(6qZ@YeE? z%k0BKrUbNnHVqZxAZHSG*d_NC?>1Vd@ zGp+fr)Q5X6ec1#mdC?%ZI8;g(tv*-!u&Ki!%KV6}NOx%0p1mf%nv0G(&E>+*!tLpt6 zzeZ099;vT%dX&$%-CCBqPnOcUSiju%?ia}|XHW5M)?R8gDo$r>jy5u+&pLCmEZ<=#h zoR^;EiyROy2howNWRqmqWNOpY`dqP6k&9Do{3au#+93;(ZRsh~=3S^I9=^B8(F!yh z3*4^9-)Ac<)_GQIlB@-sZ#JlL`rJn1F;?D}?UF?=@qMpKVi0<__*L#6W9mkyvy9mO z!Rb?e^bXvrllQpXtkL{RwD|2S$)?U|wu?7SbF}`O_2!c+UvLB#2eN0dZ1ViGu+5&1 z@zKD`M!Qoor|<{4SEC@fR5$AoAz{mC2$L`K7}R7GOYK>BDDe7QRIT`3MbcC^oz+&_ z=K}>kty9E#w?h1jAtKLe@e1jkaVJK#--K@AFpc8y1KmP9a1e*?rmpllRFr88Q~Q;V z7T2B}Gyh5DJ=R;6JL|b0kY|D*wx=vN3&tkyl3%ikjpdj$2p_k{BcmYFSXh+-0b^xfJJge2!&t5sS zd>~6Q!$1FNDl77svTRudh{Q7blL#T1TBj(9za&1OQ; zbg%EpUy6UN)hJqUuRCo|IA0(OsY3tZM_)n1uh7=oADj1Dht{uK)pdruZgs{p@GFg; zotVl;UFi2#sm3&Ziw>vb-#EEK4Hq}qJ<2xu(hH@7>kd648$}-568TieTsqwzzt=w+ z&)_E&o;ieuWJylfW3^ogrUkq>ZM^8q40a405=A_MT`bjU{o3oy{2o(_VCN^krN)*w zS$AhRQP7*;gF3zIMa-2^leWFF6Y?@ug#o`T#j_=6Q(1ZojhTN; z+xL0QiQC-_yHZDFsWj)nPQKS&fxhwuvhKXvqX>E0WW6TkKue)1*5ztFmwx$qjee!k zGV^S{F2_6xUPYz*O_@sV)Z4V{jH`GkeF=E3Q>(t%#Wpg3=}NC>!Kq*2N$GS^Lh)IP z*zW0xNz+}bs7UGMf>E+x{!T;rDBVk$WUogl_iaR_{j$*kqyq?Wlqa!;#kYSbQj1r< zzM*W%X7ak^6|H@u`(Bl}7bBpsrk6*cf5z%_aYoU+{&U6NviQl5&+U{Rq(krJY~TDU z4-S&`ALPcy(BNAXtqsn!zs6oXbZ@@4^OT3fz{oUdNQHNyvL+ZuaQ#%bIc&P zg8xJfG9fTYAwC-X+pmR$QU?cqG7w1OhoKKdhcutB=0wKQeQQE!%k6c3Uw{OJ`Z_NX zIVSj;H+_X4nSGHO3t{R?{(6*6%VF2PULgz4Mf>B$d*_b04^VxJRO_=zzK13Emq$+X zaRh5+z<3xD`4Hm^)?j_y<)hs;y$;c+v;H$C*F^)D~ftNqE zK3Gf@xrU9Bv9hcLwCDZ)`an2LW?4(;ZjCScvx{t2*F9z?bAEmtyP6407mwpkQl?oh z`P)wwjwdTBZ-bHJ^kD3B?phmg)VWsZ@hGyZE)PC#D z2JrpSFYnQOHTrRk(a6u8jJbJS(k} zDcg>YOZ9!Ia&umSi9X%!K%jjkU)9fuqcXTmNZEbeSTh6VZt9MymP@@-wwClnA-47F z&og562TXZ0X`LU^a?0)}kW6?Ycx$%&t|hp|;o@$IMq?{xBW~H>PMt&MJKiGBo?3CWuKxh*Y)rLG5Zt@s1V;3e!|3A_A=BTv z7Ul!C3(!~|@fN}-1aa|3Orb(E2i~%y=ub&#v`Ra^@n5o+I%>WYuq734R6tbm#`K2M z2|?-1v*odJK2LB~Pnx6QARTgNZXd-ZX4+nQ+a2bb@v%|?+{G>=-Zq0O%00SI<7;(?(Q>eWurVx- zGDzj2biWkFF=EdZ?mOW>wpZ@iG|B_;EvU<*S>8WFpe|V+`(q@=D3H#E&1betyT16V z*GiLjmoN$Q>pjl+)eneg63F%hlZIR%>jdFKUoaC!Vrg#x%C_#9XiJr=!qcK}M5*BC zxhgfmaRL#bWW>8KRvHGv0=50pE%4pR9+o;UO)+xKm+HI23ba`@2G(@j<$tJS0rYNi z2B|psnviA?k+xAYg2Z*gJT+{Am-S~<6L#bfj1Ql#5l#ruJhTpex*p=9*&v|7K=97m zi$ayWR&&OmYsY_z@2$;13>2qY8UdS9O!%&bh!Td0f^L7^QH`JQG|uIFpm(byi9E_x zvs>CMS3sAwQ)CxnqLrS>h)^|UYZ6PHBMGHrqtAdw{biM(Pk|~fQ}+7^ze}9>AdGnZ z_s)u-M8USgvsrWZu%j@&P_@>)pl{vp5L+we4Ovy$u8|SVTCTgkRSvh5Du>HrP`XkT zctXmkwGq;GVMfDn@f8DJOJd%7&POypi%oFkwB>pm%3n%?;K(mf!$Y3Jntsd)>%q5h zqnI?q@lju8Y&<THtXMCl-KU|u1(23wRYd*5xFgf1X@_KGNAkO+5C>*}27%xRk>jGRzQWSjeuV3G{qm~VVLE@h~ z8xAG$rD?vqk~|iLdp}sxFR)xFb7h%gQki%Md4z|TQzw3-nXNZd{@wox zMAJftfkCgo-5T{7du*yfHukzSvwK?Ds}P@E2}_vtKRiX|&n~I-YzSS#dd*|nGlT~| zrl+&!ZqIyKHtTquSu)uO-I5M&qLw~?*ERlKGe$lExK$*HZ9RKdWZymC8K=>MYcSt; zwmGQ3G{@{0XDjVB_Q}g5tYvHh7b6)!Ra5W0>cWeq-WFYl2Sy_1jRZ0VMRO-xLsIq+ zt`M1mnV?VXN2fSy1IoMVY*75;&VPKGlh(aYyDeC4JZi0rI(_c8MgZ>8=Zh zL;e-T^qdOcBiw6(W8JR>McMW@ID`V_qLMm88;~Wzx3i|`!uH`kKX6N&VY7Wx{7BCw zcIVS|Q}3Qz2(Qq#S5Hxxyz__1*b1D^I6~XwIj=Nzr~5RU>z#ji4+nL@lrsi{T_9A; zH!S;&mlk!B^U2Sj$@!}<5{84_U_go!Cx)>|FlQ>)!FIM`BEX`<1_njks;m{Q1u6TS zsgV7=jf3CGzO09Ye#J9nL&5jWcBx_c{ep!2W%gFC-KB*zL6SATB>rC2-QbNnLEaUW z&sEW~ z0|I@z)t6u1ULKRlB_iC5*5aALxda$=Js&TKD5+NONi~Gt|Li%AmKHC|u=s7c?;*9? z9s3Z+vzZ68O>&D76TaunS7qux!D~%s{z_g`Q18j)a?8@O?}ZLLwqCku{}6PN->?Wr zytIS30HMYHx>H@JjYCY!lIc_`!$1VqZ3Zi}4hnM2Unhha!~i}{A#}O-sGjzIXs=`1 zikO+His!}FhbV5HKc(dQ6Np=Xq)LLjeYC23_!P9#V%$7yv~#s$zc**=yUD5>OM zU$DJ35Ad#_D5!Vd1;8_>B4tS9SievDVY1bW++z$Cv1u{#f;SN*LodqhnL(CP!`ogG0@D-dB(3%9CNWnjDRC)#k z*gi(Vsq&gOudhUjGrr>tdhzUcaFMcv~^kTKR9qD=~ ze*TR+Q&yE?{6xA-gf>tTw30Y`O>RHa6IJ4IcZoOz!;SIT(t~z8P-+hcRw5i+1cEUJ zJy4bcczJeJfc-y0a)(I;L5&0q%P8qV^khhP>mb`$W5rJ~zz`(3YJQo9x^Ep!yf z7ZoIyG`1#tPr%qvFNgV(fpE!8+l00fnpoxwiNOs?iqs@iSb>ZiuGQhzDN|bsU_dnD z6MuZ=)P6{RD+v;*Zzh44qwe^VRSaEfRY@d`*1}y}Q^$k_t;1!*^Ftf1<>mKZo7Aux zttb+f`ynL?Vs*-n99y=B0|>0Q-b_u?%~cBDrAh#s{c?%YbQAn&GGT=gMIjUUNzrrD z>!t4+mMA~n0_Hb+#ztSpYv7_{k_D#y?e*6v4+{`~%}!&9@|UU(H@~046|(KPJ1=Ll z9qM{Nv?^68j3D%xpV^hXC3fgXySb)bAvSZxGKsNuai*hyS+n?qgznvJyYb}_x%K;C zEXgG!z7wwK6#`QiDlQS;=k3k)J=3Q{pj}>`S&%D)^4*D97IxUWF9NzfU&fq>V0upL z*nNgE9@LR?Z1hji8crx)ckGYZHuuXt&`iY$XEs76b5kBX(}C(*2U||MCp1P6qUTT1cyK^+sGY8P;A?DgrySv#KJ6hY9~<{I10& z7G#4VzZkxSvDOGSlEBNzm{l|qg%5#>(~cM(8eJHS^fLP@^aJS=^rK%zij&iKPwl9R-Q^TQ)v>FCs43+Q;uYV!m55MAFiaC7VMEl!MQ#knwO+j?nVyIw0;R zOI6gz_?-h%9y2Rb`7%ITElOZLW-zK}K=k;?Wsj>{I&}{@{u#wga(Fc<9s(Ds07SO3 z&MsR)k20h6RRKRHWWkptJz&Epm+kn$aZc*cC?k*B2h0>DCXs-vCF4fV3bxOZ&S_he zV*0~!c2U6#ucE+^sqQ7|ajh)R?|Bf6i@Lnl4Gt|<&x4Ruy6%U1yB||@;5eoJ%3NQ( zc6ZXq@6@Ma&iUXlHhj}&whpx9B_i6i*(#HvJL#->4dCi01PQTl(JY}9v4RYbtFf0> z5XGwlE;pBkePc8N#%tzb6M?xb%L#&~|S$8kjU$7K3$*hM3>GQWG zM^K$d=kaAsWA&LWbR`~tmg9gD>0Es|y?q5=wQxw)fw|RAWS{;@4z2ULvZlC16Wgy~gSC{rtSM?<+ z@{>R`gsmXDUY&b*hWl=~vRBLXAVH!2hp+M+Q}>x;tp9R{htt!Ikbc_1wA*>2U9tP( z(|hRUz*Y~h&$Ba6v6wS2I$W=Onh6)2@Lk98@5ue5Y`+I<42p#^3$vBBvr~?8zeKsnnS`i;?{}TQqC> zRVbSbV+-L^*tXm1mrM4D9B);9@B4WLaAUO=4&UO{0CwhRgCkOAw4}gy&h7y?qsv8` zx~LQBdr9z*w3@E6;geBRe9Rba)UCo=ulLRO2U7obKqn0d6elf)xcF7d1{m1eYxK*g za4YpZNEYm9ohMq|C=f(6P9X@OU5V`gvHuBo6~_st_#T1pdR%Xh-vf$i@k1)rxL-b( zt^ncZ49tpKyVJX~O`khPQx1Hp4N~)xMpJzOr--d1x|Ei z=EN2%ovSb^ZZEBPlOqnsej}Ut$FO!6fVaYuqF@OzCj7uScnoALb6oKVvGpw~iO(uE zCo%*xQ1OA!>-}{mqfm)U$6RZ7*QpEsmd!{<@NlhRT4Jr(CgwESrATuGXd?Mrgp1Su zs%Fzjf$vH|)_piaxI0jjR1-pkrNE1%g*~bi!3i?q*2S|osVL?M=e8D-9fKg6@Eo&E zUAtbS$JD{kaL#{%$nYVI3b#o0@~#<`A@|gnx~iv+OwPY^u-%MRMRw`U6yuIIk~)wV zkN3ahNt75k+UpzaTkp>t$~uU?S;0~Jz)D(l<| z9OrFnvRgff_O3JdTagI4BFK2$ytKEqx_bqiqMfpKN|5o3!km)6KTE?}+@Aj~KBl!-+mPnA9y!k0y$5zgEg1Wd75q@QRGe=8YE7|#k+{5Kw!Q)GaJeg zc{Y+IMAZVpcp4k#9+dj72RW*nxFJ14RBmS-)>DF#BRH!=k?(N1`)0#B!jG{r8S!@T zt*7zrYhUZANonsO#5i|f$rYH@U7(~%xfqT0&UtK_AiFUU!LRzGABGtivx7r*;+yxj zt^U4tqfd!|(e%uY$*V}H^E@^p8p)x(OYr#g4}t_SVhslhqqi>n)p ze5G&qi5qv#)*)dBaA(@z`Mg~XQwkeuy;uafu4u~oT)WZy;AZx?6&x*;_A0|?)24_~ z`#J2e2>Fy}I}WYDVW`GEl(Hmk?2&rhRV3{Y@w^7a%au7aS>(vZs#Zz@bj&S zYi;2X@7Z_AXV4f!cK%s*01URP?3u4@r>C&JuM8^(zDm!{A)-yXfj^;rU7Wcp~L86^Y7hKO+O>m|=`YmCdu)zy2L zE}R*KTI>Gu!`tHA&E`LYVSr;XqK!b(_Fx|&#=^H{!POW(6b1Ww z-UnxD2_!CW(YZORR2-9&W^=7me^-ij`sZDVvU7J(AOvx)&Lj#t@r>VT0aGW+7nL<~ z$3-l7yY_R=)=oE5Lm}5Q4ZP_sZ3{wf`yA5y8Y^iW{@tDN-?IvKvkl?iZ}&^C^RHd^ zi`tG-mwfzlHS1S9eFrUjbp#*N`j#KQZ_sb2Z4WneOtQem$_*JwM1r?n^C@<|*<3ML zi?yoC4DXwfI;SIrIh2cOuh3CYsMI<6Ax>#p_scuq+))J|MHt1QSX{8X=j;ge$cz+; z&8+aA1_{A^N+{*8bD^AWXW$}I5OJSF$JK9yEDP!KwWCQvh+GU&-e>mr+bN-g+9Bcu zec$(idU|pPvbd!Z{D6^fo_&13j z39Xwhw|lHBM1&CcptB1f1rQ8)q+;^zOG50LpnK!A!5D7(-}F>JxpUfeC=~e-OJU-uGV%CM6|g4 z;Krqm!IaiA(>9e;<@x)x8CgFbJFb{Ft&2Uz8}t0J@mtSOD5qe}j5PY^oNX~jhi+=X z&@R>?abOFyGObu=`3!R)FxU%8v)>vrny_Wjc8?-Ppt`E@Anuqc zPbmHn9ZjBDJl7wO5ZSd-vpR2{6@w=Pj!s-_pe_Th#r)4#Am=>4_A=*>x?LBmlw;WM zItX9!!Vls{y;j7Sr0|uubCjN^i%h*=$fI-A(MWbpK%Sq$b=Uy9{Zi*+68+Mk*1FgM zN9GrNnB7nA@krF%adUfIlQOl0i5OxT3lAG z6DGiD_fCbp(;duffy-M+t6@PQ;uPDKVvROo1FuFLWhpS&z_Xb%0WAB*b^ks@{9r@# z`RIcRBMFE^2Aarg-+;ocXC-m^es25{gX`I(wBWjTG9!bLZ8M6=uQWo+@4w~lf_}-< zB;!XDoAm#wSQuBdO%X9~ek;xGMNrmqXGBZ=@wUs`^8^>Y7M>zQU7QEIs93Z!3$I00 zXdNYJZ&RRKdzw^OS~TT6!9Nun&4n~U(|+WJXKgyvj_g6UOeKJhyAw$_MHFF_F8(3vkU=*r)MxSs>5aXgj za$?_n-0r=XER=S$xdmEfD69woy>%YRk6icUVI`;m6}fU^x}55qxOA)s>OH{}6XaMk zq>1_OP-sh9DgKeq6B!E4ct-;{(zY+Q{jR5oi!`)8Td=8}O`Ok5zhqm6(mT1xRSw&M zTHrXB<@f?j92Wi8U9@EYOsEd#Aex4oRyX;y<3T1QWbN_0=;#~pkoTWx_ekl*v>m-P zzeuAGwwYT>F86TRr*NP5q5$C?!0+9!@o2)enQf;US_%>c;tX6{a_T(;ofa=VkHyV; z%i6)``tO{0sHDQZq}#i?-FNRe^3OXrr_({w4`CK>1+Bi_B1#ehzwu8A7#bJ@1WT4W ztCer_2U8t8ug4zY`wN)sV^EKU+SIel$BiB~e{+4xV8ga#C(lE0u-owhzb7|7#hq2U z^x(3J@M%&KqAgz9BIbkAfookf`qaYXvy_h<>AYG)TFX59QOs(6Wo{R%5q=qcmxYq< zLYL`hy5GJg7j`|h*chQ+S%AmRx-_&~uKzY47J)m+#ouIM6aL`Qq5LAqiS|cxh2xC> z6~z1Oz7Y7x<&OvC3V=-(wyRgE_R>!@$mbwyK5ky9oKBzlbJ9mTHEn542;pO)HLx&c zQGVGTEJNrGAVhoiU5jMoXe7p4#5PQxlJ}Xn?R$eBYe*+yM;o{2w!G8vyEb!k=%%}l zDzM;#IL#>`Ak~HsF&y??P|D1*egnPh)o_Fk%2PpLh_C=FQ~fr2kV@NZHeKVK?)qUz zOWY^04(@ZSSXt2oyT+7iqdS{w%ver;c z4d#mmZRJqVPZl-?OP?2_UB6^0h7=A^up(|Mf12RUOgyXO{%}d<+n>2um2&lmvHc0I ztwce$yK8!`>)UY0tKL-TH&B@7J}9_y&NXs8M1p?#6!(1T;cYxQQy1+m;~9D|z0K+y zaKmj)A_~`I@Wjmhxua62wJ!Vt3B93a*G0FA&F5e>dcInJ3(mlmuv-MJMVev#@uDl> z?VeG)Np2G8p0&NM(+<*>2Qh+r4m{F5Hmen-{I}z55F+b#BBBo`#o3J2T@PhuGubg-lr>*twd8v#n}(=g-@;LAlEfk=v~A1;^Ka} z6cpp=eRnN2TVp6TbxqCp^D6}7a=VXswQjRIHoXQZo7rUI(oi?(X{^I}1;l$O&;^HS zwqcZa*#CNAqNJMO&8se%(L?3eIcL{)2^UK2!sFf@7C~$k?-b8Fo^qx>gVEkHKS~L7 z{YSaKY=`3uQfc`d%oz9&0>syT3G66QFf+`?ZrRKorMYZ3p2XV!IHLU_ z#hyhGoRfZmMz^yEyLous;U3Lhf`&PGXWVuI`b<@x`9SIL>lbYEJ<{jzs<9jt*!@;# zwZK&U=wIp8d1$k8!4e_{Jl=2PLwPPWVN)~9TWzsFjY2G5w?MGix3|*v6nau;GVBz>ga0(WeDoJ*V17GCg9YG% zIW%PHN!<+{Hg~iwzMl^ggoZNn2OCn|mq-%gHXEBsh$~<(hJ0y`-%KUKa~5iFc-u{N z_&Ghy9p;8wG!2X0k$n#P>iTxvWF#BsZ$+N9-C9YqW=-FS=yisxtjev0K*~Nw!MFu(E(ws| zZ0A_l@%!!OE{i!6#RzMD5t!1@nKdpsYK+;i zvoCd=*OeTDpWz@A8*Y9)aGx>F{w6OZoE`2Bpi!

xC)M&#l`e)|gwE**g_!EThN zFfA8sYnvwcbZNG3gIDlLZl4S@GzY@%r-LFav8aObj6yN4o$h-A05QQPL%W885_= z8=u~2`gCfM_vo_R`^3ixlvODl$x|_%iBAhk(nB;w0YAIkmh>&Z=wr?Cm?nuTiCxvuUbp(atJ>Zf~k|98HlR^fi zQ_U5%vfqAF3SS>`1-u1Qj1xv<_w&K$5sZq%1)xG18u|=tfiKbTzrf~#O@+RxJDBZd z2Dzb}ilCNWZ9Wj3=7+5}94?k$Zv6u;hp9k!)-h#2EzHrz{P?jnZaug#b6EhS#2q(S7l@QSYHQX!_3LELr|14TlcV3;EEUcdtIrw_oof5= zLD!CrVcWB9gM6DuH)pHbKBa20us&SfwVEeOia(iozK`@LrP1*&Bmlc&pud>hMPf~# zx9H_1HB>tE1?RGqR93yG(Wg6qyrgjGg12cGzmFE;5$V)eUT^M33x@tY$^uveUN2+~o`tp&qo)&n0VfXyZeA{W>-CEP(!MX5>y?T7Zl^&eS z+V6o_uEACUoGZ$NSpEYz)m`B8@}R6u@IGxXqGe+BUEigV`YSdBfy#T^VymiIDzBRA zHvnG$Ot$YkE&5Y9%?w2>w~7u6dZh2w4lEV#LKUnC-tRgq6#gs!ld*-&Lu9ci{&w9a zHT$>3K1;v@kURBAzjV;X$m)J&Fvac$6?hv?oq>zB^D%WC0^q8|Doxt zqni5v{{;~cM5F~IMUYmyk&u#*mX_|4j?pEJbf+|s*``AfYrwrd_9(9_G`#3x>+K;W-HNBMWoC(#;Lp)RjJYLhAHi7J#oBW5cVwGX+A( zSL$p-47`y|JbQIapu~kO6+^ zBZ%U{%9&Dd;`kWHptbcxD||<|1jXLN<4q!?jg;)0D?g*OLdv@0Dm~%6y1mUsFBb9b z-@77UrS(n7AAuyqUvkK*58@Cwvi5V(GG58W?@k%*sIh)l%n%KyNe8vJJZAx)Lz#=L ziJSj>GoS1@cQqqus7CA&V1Lkb_l;`ud4sfQ9Q`Q;tyE5R&@mT0kB;g#NutecWNu3Q zWI9F=ji6CGi+TnaKX1FBN64!lXtP zKSqQ#k*ci?N6kWO43Xw!EY<@IO>r=e`op|l0U{yYAo)r27ECTG$VBds6yYjygVr%C zj{>PJLl~9HR5a;H4eh<1*IGm9RCN@*z+f-rp5gM)h`elRcIFl}) zR0kl6S3u?&kc3g$_4Gs6#8$yhX-*TPrZH|CT6_(e#LYVYhIHmGG&18`#C5KVez)oL zM0msGoU#*cMy5-|coX0@O3 zR5RTHTX$<%DI@}wYE`xpyXDoUrv#J9T-3QokhHV;E_*U9bQvlXan(fHT=veg-;}+c z8NOlvgCXdn&Fg$nM;7!|GGvaK5o+p|O1Z=^)b8;;TIk`>_Zt+h5Ou{^QBP=JnbefI z_HiArEh06bSnEHz7zC(qCmsJhbbhKtpT@h4fg;oHGsf<#W&oi zxWdXc{AK3p7DoJcHhnh%xH!+|0^4iF8sX31SU0TWEp>FFnCp_Fz0)RL4@7ZT`_xUs zz6v%vdbuf=4?NT3!Q{fy7Yf^2enDJX4|qF&jO>jHJL+=mobMGoHr#rA80_*+LnE)( zFh%Cd*Q+u|#sdt~!?14JFTKrh|FyEQMfqaSS`UvB&JjWW_}Yi4RhiDTI%w+N&Sywy zG54D{hK*p1qfw8ATPiE?^AQ7enq)^o5uM&aH-ZrgA!9}o(xY(i^yW|Pzp+`m+SAu8 z$M3$@lQ`nNCv*oug8Qa6pW*}{Xg^Schd`r<9JJJ+lWB1eb{m}-kGCP9Du5w9K` z(y|&^j$FF{XR4R5M*KS}ReO1af4yv-pK6LAY|Q=uLcHwO1-9=|@!pS(1#r3((^9* zUGH+S*UZ&Cy#q;Il0>M~PidwPUtPGfZVnF)WTJ&zI6}c_WXLp$v4yT`JiRHEYCZHA z^IE1?z>_IdFf&2S0pb|@fv!b?AvN{x&$=^{$h!hi)#ofWDgw>Dr}7XlP3!j6QMl=< zP(%bfUvDSTi?eG23_xDMWDy2FifK7wq~L08m}OFJPrs9h$ceNiQ1YM*yXeWJ3d#ma zaPHUEd0af}L@Tk_RR4$0ai78^Db1E)(7=d%jh=%cRU-pdWe<}x{q#3TP)x$i&1_7} zt ziUZ2NUUWQhqi#uh`N|f<9I(k^z${B8L`M5ZQAYygVdmc)jFrS2Rd6QhcIuH)bvXU6 zS{t+_EoJfB9vBqk?qzf7_4e-?a+1u2h~aylm*WS*nCg1Ww{IjiZ-^#{iN2iNy|;J3 zYw?yYHexx?{$gd5gC<1N$D*DjmGnfDyt;9-xKnYyvzu2YUg$h*o*llhm^_c82#%4{ zET{_(#Sts*j5INXr$?JQ6vsl(l5Fki09ofNac=cACk{VMdB(c@wh=a_bC3{#B z7Y$lQ?}RW&7x#^BC<y42SnG^~shl}nKO zS1TUc=R;4lV`%mSJkU^wQ`}{LhhA! ztZWAVoI(`EBe^Dc!Jt zQ>n#KkNUbYd?iNY;sF9?5R|=`H#kA!j%;5C$GFNCui(0~yJsF|bz`7hLd?I>U`;R> z9Szq83S2q2s;&G+BnSZBWgQsd%JobVeS=WRmKq%kWJClAnK^z{e?9y2!&_RJCyU3< z1bSp?YltGE;7u1TDb2tA&tLWTQmF)Y{HIU8?bJaw%HEoNmLySM=HhjG)qy9awDCbE z{llw5Q+}rfuLhA!tW3*n1r)S2ihtH-g(k#ap%{clt=1Hovz9kxoN_-bJ2UI{k^!7o zFS~RsnqNvp@yX%Y%g*+TVFKejrLUvQHc0;s)n@>S8r~#)9cEyUW6#^94Sf=(weLhT zaU%PenNm$*r=+9e1A7Gi#BJ*^-0OD9c2%l7-lnKnu75Kbm(~JK^D|j>`)q^*aNX&_ zBXPOdHcD_7bDsz{S$jMBA*|ya4<-L%^{eY{`5opweJVM9S556pvHQDIVSzvG0nmgIreOR>5FKd~WSQ-^i z=<5Bsg?V05%t*w>$VTp%`Z9CFzR1(HwmrhZK&Pa2&fZ4u4YE6z1VeC^Z%XIngg(We540xe~st8gU=&cQlBY{SFu?>CZjQcP4EWoU5h#M_h)WycV4q=gMcN+C8X=>+Q5paBng0owZgXd z5DgPt$vBaICW|cj?hPFJP462F(Hf-^^O5+Zv$|k4Nz{CDJh^&hlumOR2?oWnfb-(o z+ZX0pk{yC9n7~J|`t`#=)pR^E9?8-~eZ*$y%j=Tga(IUoAWL~+^IUpADdZ$gC1Af} z5w&;vr`5R>p%dUljeJ4ulJtxEu%t{a|5Py{ZWn&)<@KG)esba`ObwIkj+a*0uB3g$ zs4S@NqBMwFE@BStfXBlOws^KSPGPT9m(BfL);#$?Qx#8)EqUyl z%zicEtTegv`VRmGBkt3uuZx&piDSq-rK2+0{w%txfW;@m@9z|(NAYNgL1FuAb}0m# zK$e1m>UCUty@QFd{VIL8d$;;PfJTwC65q7|06{dTVAX0K z=(vMFjKT!^brV?*`c`#-VE@~GaXte)^6uJ^w>iIYZ$;|6y_zXUs$_XNE zlZuGoPf7o1ZUgAUcJ8hbYZ4Ff3~Evt6@71hx_R?$BD` z)yI%j7;@Z!>8}Z+*-xVdl}x)i&lR7ufQyh!vh_M{5>9Vlb}6zh5($Ao5 zD#;y&B(#EtS7|GJYLB#cZeX!Ug#wfHd0`+D_|k_jCCVW}qKIvWebSv*A5VMA=X=UQ z3{=l|8IKOj2l}ce2W%39zmu3@|utn;bPH#X3cu14F%AGgC*B>2@+a9bTP81*=Gjs`Fiw6bh8H`NoKWWm%YH-c+n}3_sUwm9>}Low+k0Z$mMll z;1Ul3iHn;i-4%R7MC={ohM5u4=%=sf5$0*5d8;GRRY0%jk}_o3?MGwn_YO|>H6F-f z<2@#qtcQ?n?^={6uhgTS_4A#}D%B5*YYqJGNkYU0I{mx6ij7`^oP>|KL)UiuBVdhW z$C)mW=HNoKBf*meju>Elx2byT8O>tU@Edt8>O65aLdX3Og31?Qy)Aq$t&IW?}W~Da4~&6`SA>-j6i2 ztU`SEucpOTf4C>_9t8kdlwe|i%dq)?{(?VehP5t$1JlUyu;(NvPBMX^cj=CErE#$V zwoQ60lC5zxSkK!`agOEuA~};!E|XQo6v?@bPxN4E22M#5Ue{;JF@ij<+p_IjzE}R| zlsVLB^Tgk5wr#by@z2m{4R1LK$CZt`{g;18L0cdAwj*ggGrDdUv;PZ5DR;bM`PzF$ zvW3na`6R`dh~AdvJZ^;bz;GpsrnIaTUG>CeLJZ^`H%=p+i;c3(Amt0h%hSRSji{-M)AwW8Q5Rfj*Uth2BJAFI!CEwJk|f<$pi;(h*!5IH@*q=(@j0+e~-=U_Bt{1Wn%G_ddR~N zyB(A9SD8liWB5v);m_8FM{&fOY23~r+xtiWm*V5%rV&_4 z8F@ATmCK+JMZ(xDym7o(9YoF4R+OMEOTWDla}{5=+Fx7q<(VVcXj(Fd8iOLqBBW0B)iKw0}(}QaaM$#9ySqu)vfey0Ql!b$1r^H0R zv<`Ry^uy(i?=+Yh?(h(VSRNTQf|*265Lp7qDW`DFKJh@@?idS5qMZ?BkNi1ws&37$ zQ>L$s0f8kfrhOJrns&TI$m5%s##ZRB@0a6Bd?#Zb68&_L>=a_>0z-Ggc6f#%#v@$~QMyS;9}UR-WDjb3W)R|R4hx4oy!JdKFu_2tal9=Pb0PN#*v zqJF(uxZ~A84LTjlM^Be;vjjund+!sF^Kye_CP1Fft;y)e*t<;V**H41#PNV%W=F+y zh)j1$$H3Xr57w@`cx^S6wLFsV?|?4;(+>G)*9)v|AU+eipf}5Zq%ZRaE(&ksy}z8O z0``ofJ#C5Aj$?Fw@a|R=yz$Y}F<{e~a0x9{O<8V17@uZ5TGCzY893`hfJVF{OuCm| zNAS40vV4FYIz8z;n-*}XE_#)sxwGD~dfK_X?ghd7}g+_Zb_p93II?)4tdYAWs@S(eX0h8t|5^ z^8qJm2F}kTcMXq>PS&fu!ch>YOE(P79h0>*Vqm@s>P7tQy*b-Kp-p0L`#FJ&mEkdt z^Aapb)H+ajAPZ$PH*e08_v1I`olQ!!@W03E0oKUhv=^Trzc`F7DYk6E18p6Vk0MtY zhSX*2{}QKsZ{8U=Pe`=P672sK;b;WRmYF+jD~6)r5($LO5svy6*F)?i4??5l2|3@7 zQN6oMi2`S%X90a7!-`k1cGAYA4bb){Qvnej!?RKPaB{Y+*172tfu zVlflyN(oaF8(e&Z(YBaf`%_;W&)t8dQH5DMzFgvW^Z)Tq4Ce}BZ$>TYC1ZuC4(xH5 z13pIb+pP|Z7~S9?&tvT!t{Qe1+YE4y19sXM3oI`t>wR>U+-p5lCd#H=z&8^Di11d2 z-TTj(6CB4IV24!hLvSo&zSI2H3)LMS@F&=yG!5#Zn^Ox=gCC}w4Iv#x* zIP7$_Ydb~22hoR(j+4&Q=iu+qvL1jSdDqoX6%n|Iefz5C;<9)ng9^=c!BoH{nZ4J& zvqLD<5`n1HW~pZVerCPnZzS?4Nw;!D#x7I8xV>*+FyfZbf;|P9aL9ff#u2y;$-ajZ zBrHLwnxXWK+>XDuuxn~=UrLUy@FQ+pPmU+x4R^MDFhCA+e z2l0?G%ZU{bBOgG1JJ&udbnPx`%Kx8m6{Ic6qx;^%)Jhae%)EB zs@`3E$D*q*V4D>u>R$j|zsUPiT`hm=sRR`3_Y~hRzLppZBsp(Z?>{r81R-FLe|w5? zECc0POuQSX0#SfR!E0ao&IIc7nIC^oN09Kg4eM@*(gbrSsMh2b3bEa+U$jfezk`iE z?sZ@10X)=w@;#Gvof>@!j#fh+1FVv#*=oOZ7<&Fvq4ZCv$!YBs$%R7oVeJ4Na&tn7 z)wDp~iCs{)2i1~fqng7|+t9RR16O)p;xes{mE?7$O82$%gEhhcTYpZ)FU+W7qL!4^i;b~rREUTQZZN6U=qlk*W1R%sMHx})_EtD2_?tlvk}7+ud5&6{FN*v&4@L7 zx4c`gK3}h%V@>6r1FJw)_*N*pzd_Y`4a7?Wok`@Rn`brEvbt6~@;HRhg1u~(OsSl+ zzS|}YtbbR`eAknCXY*x5R6yS3dctB9x0L0hu0(AJ$nU)n3dk_E*~_}2mK#pAvSnz<`LzNVwO;F3)@T}MAC zz2_hQBf#fwq2(WnXwmA?sCwWqa-@^z82!vdr-0gB7y}^UJCc`<(=Pts;)Q#g5$j&^ z9;!g(s|^zX@>Cz270%lF3S!Hu9M!%uh4=>S!rd$zHkO7Rw*vI}TEM5IRT5TMZt$ z9PJr6IDy3xhBtci=WA}$%{X)%kMt2F0&6ZZ$jt$VB!Lrlx!#5Pr(il81k_~X8^OMv z53J4}*87w&R#5w!d~Z!q7y){&5Rv_EMB&0;E;>xWsHpHO@x4_2*FR6vvB&l#5T!Nx z4U=>mJ;b5$;pYhm`%exJAj!*+(y*HG5_%h@OYJiGP>S$h*cg>;i(ucsCIYYy5Ry?K zU`tLgLqAR5Q0!pgDq2$SfOhz2W|fl zO1&_cEUl~N{$vh)Rq(zOBro$K>(BUXOGg*vj9bC=X)w`1*NoVMq#>S!wUYluwGK&qpthAG*hFq^WQo+6% zsphy%shdtMFC-H+P0=Pb^tjr>vrGnX@BnsJf^81|v3w4##BE!sAo-QZggXhimfZO8 z*{tW6>>5`nw#7>$9=j00S>$=}sH*Ck<1SXrcVl5+ zTt2x&(eFgKUuf7F4U=$s-PY^GDDn4IOG~NVe7osW$c7y)-#PMis#gkQ|p9X zq{Zghn6zR1y;J=P^MTS!CemDMTj^B?v8yX@XZ$(}Np;&R!{a@3r6v%aSX{N+$w}8t z#suO$4+W(XHJQIn<8y6V!szA05G3b%_eSB9!WTPxf56cCMjd0+!AI(!YV7-5|Aswy z8e%m4*COOm<14hNs>xGnOec;O3Ue%S>=C!;{h1*o>>ne|RyC^9IGWEQAD7cacQUw~ z=t1GsGu+H%#4f2LOENi|;*L7cFu3OFf?M<4o_i7K3rw(yyp}&)UgXW=4i`%fT^n;_ ze$lpupSrT)caxX{Z^WME&oEvrPQL2e*T`4#j(pd2?Q@^?-^6E5C_I8%=jH6dsb8WX zY&&M6G!NL4efzVaCa^tO(c-HTiAyt}|9RjQV_Fz2exJtNB+oNdzyRFI)zV;Wbnkl( zs-OO+h-k}bO0wUnY4vEY)0sRI*{kAb48qD)G5!Jj%;Ha$Eo~qTrEd9;M8C<{cCEXHh`QP-!QpH3;bcFH{Zd)OzA^7uj(A{IGNNt$(1bQI0-Z}1n>@lu8{pyq4u2kJ)RrJi})2&}Nhr=Jh z76*(Bn*9&V+(PPHkx6crSZgzn$rv#&^nU!VekkXqN+Al?;K1Iy+tZQnUGTC!>D%|7 z^$Q(9)O(KX(nX@rT^gJ=#B}mlDQ1&FD8uOD^hnv?MA);Jn&@R?0*`XOS1;Su(o`oS zJr9s#*E4Q_M+t#)Tu8O$hx>V7hwsHuhHwN0hTyA;&Ru<$O^J(3UeEsLEEYtG<(|F4 zI7^{{NS)qa-d7t)_-|jjh-9z3TU7zm{;+>@ekrHT5aa6^8A8hz+jr^Tn)hk_R-%aB z@{AmbNYI_N^V`hOH`cJRYZJM=dq1(NK9T57V?G=|MjUA`)0@j<8I7{&%nvg|HK22Q zuZKYs)Y*EX#F9)RO8&8$paJAEIza7IaKUPWjb5c!{6G*VQ>9n#r_&Kv6OX>jE3M9S0@~jgH+4SsW8;4MPQ&;Wf_XY9Nl^cp zF5#M%oQkPZIV%7{BCxYj)*&6|9AFUsnDe?yHCx2_T;~@=LqQQkch$VUAd_P- z*ZSL!M2?(%XT4Q~h{>|)hp!`}F{;}#KrLl?(Hv@Q$lpQ+wK$7k@*$x7_;wAAUIK90 zwQYgiMrNvFebA~eG~e$mV0%ng2pnCD693cvN4)A#EB6?9#H+7~>C|>zIsg1tX#D%9 z?U-2Flsk#tqg?)?FfrEQH!d9@NvaaKw@y2ST+jV4WF`A1o21YD#PJk$N!y*|i`Nrx zHS&^%O3a3cci)*4qt@?`*(e*{W6!C>A=0gcisx3hc$%b9&rc25c2ed+(5v?Q#v`!+ z(nDz??#ir?o3{y2dfL+6<{ul<`=(wI`@d1q0NLuf+^je&RurWdO7Bo)i@N# ztHyGJ$a6`GB5jO9ugy{}f8fz(iZHYGqN}9&L+-hI2+UE@WxC#cD43&Nn@=?(U|q(4_%fG zqkDOiOTku2J6<~PMNrH}C+koK`fSPa?lt5V_Jl{?v~KiJ&)0Y)zPg`O<*$_^ z1i#7C(dnI9u*QS#w1J3Z)lxYL?S1sw7tqD=-co@LLoE<=7fq6bkrl=d7|=Fh(qzEU z-9YTz<-!S`Tez?d%q2>r@|id9IyP+}x*iCTF1qj+S~5MRdjAaIFDG&1PrEm44k&v# zD8C%!>g4MXMg4-B?$RASt0@DlHi@JEm`(w^+GMf0w9dyt`R$)boGr?v*X`c(Snxi! zw{eCQJm^Qz>Uo22iyP%>c=^-50>P9T5xdJ;qt5AOpKPI8L+7 z7HekpfD(r1au4Jif^`fD*`*U0ub4Ew1BqOcE$ki<=&GpnRpa&U(uMYGbn?8>Fce^=E$4l>W+3KGZ@EH!cnT^bJ>C2>X+AYCgSx#1ypmc7a zF!7xgST6ZNZl_1tMu)D7bJ8MShku4Pe33QPC+M1}jgjrxk$Jcgrlq4}^;Rx^lsI9a z$6MH9^i}89-T8+XrkxKDLM85wd%0@83s;j_{1cu~N3ZOU=5lRfATcx~1uIEb8(+~$ zrL$!yNd>FR(^#fI{9fy5{Mut{TIw+!PGM{_LW_VsamZ1t#{^FMpnZd|sDXqiHN^2P zmKjY@kO2lIHT{!dkEl;Z_-%bkLg_Xsgn-w*=ZmLYvd;REd=j9!Tkp8EJ{8FfruOAXwubW&mb zU3D4^h)HAPztoXmVXaQO+N96;6F;6JrjJ&`9hH5{CSCJ_@Sax8qnIIQ>s@9eUZ*jS z;Bc0%0lMVN4fH(WQ6L-m^HJ$RLKHq-V)J#}si&UYp}M1zg=M^i?83wRVoA#&-P zK)R>CA1#`4sg4Xr!yp&rn!8s%~OwSBqzh)}> z85$-d*B$3|pJ$MyV5Tga_CT6TPbl``GZr4hsw%8{%_1X(MsVzy!IhsK~*1C@s=x?LW2*z#P*=(+-!ewr}hcsAJ}y` zo|lya)pLtWJ~VR%v}iAByXetag&$#&(RNw?GIed{7AqsZAbn_`Y1P>OtAx(R6L~zA ziidpJ?fP}qcs(H`12q&+a7CBtaKgBwAYB>Zi{|L8Z zt$k~|$O94^k${_~30Yrrd4o+yc$S^;M^uC!cnrk0W4g>-ganKu;J;eNo~S@m&E{f} zxdod&Qh2w^tCU3+-PCsGZ#?rj^LgHuQ8?V^C|bmVD*oHv?{>Q>yRrdI7!*>B=yO-0 zbK|&enVy9tUCDq_J`7!OV`|&_sSKrp5b2?J^X@=hq+m4 z7ty!vdt0I3`nu2SFE{wC^N+S@kQ7(ns=-1k;2W*jZyioL5Tr@ zptuIRkEnfG$0ztR`N*c)2Br}sC6xBh%w2LJ0lm)am(-xq@uEshAS1D|%dl}rOB38t zhv6q(IF=!e@xpbv_h_g#YdmmMko3&tBYK%2ce$!&YX~|@A$Ykyr^dbwa-075dG7UJ zr9RtFbL{RO=EMvlpM)g3K)7we3hSH@5e(fxU;U+Jre8?9HmK)@&;H-NYG~F|Eoq&e zrk!}v73ib-snjnqr=>bm&ns=276pE-BJVqh`V_xgGyH$XBnw+mP_-G*i0!JK`0xTiKo z?6Pk79gpO9$qy#%FyS52fCl8%w6yR?>vWM`s;-46$gky8F6rqPuugyZG*p zw;0LhTxYbJR7=U<$-%so@%R%Tg#PY3xtdwsdqtT4;3O-x-yRF?Uixz!EVbx@(rJHL zQ`aqm3FNsjje$&t?#XD-1-g`K*2bq}^YT%oU~l^h^>NcS{rY-<6Kpv8eX4Q!Dmqyu zZ;HY8>roZH^Ld`DEyD-5=WQaAQLpqN_Z?#{^S`?wR5mkRe;jjIOjq8tGEC+H#ZAhk zVBDp}H9IMMUWxrUY-1Y6re+Ic+T~o7%r-M$$S2rLDvrMkf)~_UFORn*r`!b2QmXvh zKKO)t_G}7Cx)cgi$!Oq;?^Xm?3H^TFwo;4mFCyXKD`(~> z!-`uj{M;q|By6%!IY^$i)cbTH!PU=vHk*4?gn0rC2_L=!F}f=!gO4v!+!{rK|1jCro*R5#k-K=MFZfFWf9fNi;k%6tVOV z$J6BX8tHT|U+Zs5zgH81`)oM?KA2X_qrN7 zR3N%0EE40uYz_U_|Fke5aef?bPyaR228=Za8ef=M0)_Ydhi3yl z-faf>bX*JvK3;71C&@v|77Q_gd&7%@>Y+$q)%%oZ(>DxBL(u+&rrLG)QLG47Hc5 zbR6$+^fP%BjHh~r=X!0yW5moPE2zqxPuCkazZ%+(WeCFu=Pah4`;bJwXHZl-IOheS zB)zR|zi>p1KPfz97Wbe3Wr19m51BQrKg|YSTOkal!FKFbMj*SbB4yCl>Ytn)S<-eE z$UOVmN0_S6Qp`&RLI68}dgSN1ZNw9Ffsf?r?<|LIBwlnqWbQNclnFmuQ@YOlgSF!gR9b7?QQJjm*n#|Ut`<4*A z>7jNd#&6Lu~|@b)EhsGD%V0 z4%iV+iy?9$BdC~EQEM7+Zq=F0*(rJwdr6e9xYIs%!Ew zy!d5>zy%i?6!j>X>gG^8F3a~>p%Qd@!_}-bfq?o!!7Nq#A63V7FFx7_?EBh_44ggu z#{n}{tL96HZ=67OyV_z5J#K%9=@Bq2akoJ5B=zOMsNK_ z|84z1v0dg|-bwJYlK4`wy{yZF6P$SRg!_JO{(Mtl@cPW`ocOP$cknK4AaBdOUXR^Z z`j@s8_-$-e>Z@0|F0*S>_98>zgc30(CpPyV`aZ5BIs}hAEQ}R9a|NGy19S1fJ2hpw z?`Kha!2#1BcQez>VoYFQiukWIGp_PN2@$&!kV)qyan6ZLN2efF8sDE*#86U!avnvR z!OH1i>hUpeSR29l=)Cyi=Fm2H*w@Jz*VT>S%WE}eBLvevsz{2^WBT29`(E{s)$Jsb z`zIyXEM%wbKH&4`ZB!-M{%4#5k5>pll48|~#=5)JkYRqUHORjMw5_8eh{5`w2Ied6|x-LKjEoM+{W zyA|F^P`#QH(;Q=Zis$24^-@ zNRs#u%KM}jY%Nb$S+^L-Q_5a?Z2X!2SN?65)6gDhX^CaHyCtqu3#eQBa)txQsq0Ry zaiLYeFn;WnH1~bryU83jFdiaK;u%|D*z!ru*?L1$yJPc>c>;Qjq2B@S*kD8&N5FPI;l+FEi%`<~B+ zN30%?`+tp~%K0>%>jZ{=4sJoU%PraMAX5?pSkG>Z#A|h0+C|i|v6w<;q)$D5a?Mx7 zxIEZ$!YJ_M=v?k}1qv2xZ12Jk%_#Mff`|RF(}jF-AXFR{?=Vq(D%d@z37Pbvi(lwU z<|+SqfsfRxwF!VVX=Mt#kOdf+wpl7LN`0iYQJoNN=frLEO}ppaefbqB8+yl3vEDE{ z!>jpL=|KO=Q6pOxoP?!D@WADb)YMIgzdX5onWJj4-yskoZ-;-sAs=vaRA*W}cSDAH=!m`Ts4&CZ)k?oU?i0Is+|Qd5-hCL+S3|EA z=;qe&uI;MrxQOE^R_gCNv;MQtuBdm|>qaKJ&?$>(0(!0dN^og~gO-}I2lPkt<2#p1 z!dDt^UW#+x`{BCQ?j$F@kft@wJcNi2oLT^Y=$l&6AE`}K_tY=6c3 zu4ufVDTY@mHCR^vS9%@e%W}u+l8!zQos+WEZDo(vIGOY^T=`Zl=c-#vHg24WGKKwz zQlY1T_DZo^o@#LyH!*Oa|JS#F%k zzsp?#>EN|N{V(Dikvon?feZ%!@GJ<$4tnu6%1upv`1Iv-*ZIMxP}|*Tj;>-`YgFFt z_sec88#Hi}73einAk_lyS>CSj>_MJ(dalek$2?tYck2#f-Eb8_XZynLgLiY+y!|X8 zV97^+zs&~+=flKEw$z%Im2rV}2Tg8=z=zxY>)S_(S{LxZnSpb6^O#?25Axf-QYx8C zYC_n`!-$1s;7ZTHOHps`tG|tDUwRji?Yrd5dCcQ1oQk9A)*qh#r%CdP`w!#U-Vy(p z%Mv`uM{pfpA|*+1ZO2vqp^p4|=!?gjg{>D)J5BTVvJPEVwkQcx(JtvXO;#1EMPgwB zLJn}e+yR$z>_jWcvkvOl$kCVqQ@^hHf>@C&s+;k2zEQS%WyPmUV~NdY?ME5o$^6Tv z@d;ziw6c>8v`!CwqTH%9uO~c!E&t&p{_ZHvNQp%8*YK9As?Fm4`EW`*t}F z+zXC9yw&nKKHTbd7%8Knv?8c;)`)eVIBs7h~g)r7>hrj zb~B(knM8S=FQ^hV-z(%9q#oD4S)Lb5VP~Bm#B6pYf{%=DbyonTh7N6kB9-2-p!yaYH zhhvxI>e}-B%oMx%E1b{Hn({lWn_kH>-VJcl;si9AlFUpC38IFR&^@=0%lW8|F9@wI z$}Isnn-`be+#4RBbybd;N0Ye>*>;gwk~%U7kLIA`qu{YY)HDSkwFn>IbbeH*7&JM= z*xmb<*DZ}?-BK$}fhs87CGol@ekg0uwn7pqCc!tMse_X$$u5`@Xis82R-le9LTX>^ z(gETJo{!=Rr@GWSw8(nb(0Eq#5b5e#lIV}=l$PF;t*JL0YpeM5_*^wzFq=`jaJm$H9L)Q)-8{`S7o{9^O_B~e50tKQo8houU!qUfJ`>xi@>~~{_-Is zV1LJ$Ng=@PortY($`ZBmt`@=|-=pSKRPv&4znh}xh58?jds^)>a8t|kwmXB+;O#pc z(Zco5;L%hw48h|J{_O%;UHI-{0E=e%Bf4YVMX;ANu9zxfv{pjzV$;j*&Fwp~n%V&# zHF(0+e#O@6A=(H79Gx5NBOyw5)|F7%hNhI0gkgqWew9$cl~~o-{NH(qHWW}Tiyh4; zrabi}q|2ewmce%5J@p%(3cm}fCE+a_kFq~jshPW#w{DK(K^Bt%kf3&$dNwko>Mi5b zyo1CLOkfYqoetj*q8F~236p6#5s50rqTEw6jpSS(IVRS^S`W92q=~OqHua$ zPOys34eU%u48mp#Lsf2lqvKwG?C(K4X>VSweh($+8gUwlM+?5tf{d*a3BX+jR>w7L zb#?!(L@Qzg0A}K1*5txQ<4u+K=)|5ScN0=7VO383raI2nwLkcYjaJhQU zw+-=n96I$x(}&tiK!WB}bh!osw^9SUHTtTw84m{@{g+zS1w>CG<7<_(Bm;Y39TUJb z(kS-i$p35a%EO`F-Z;{=lqDrs%2F69{A6U8++-(B8rz_Sh?!^_`>sJ$xI&CA8q3&n zHDs*mW(}3h*kdrV4Ka*u_H{B@q^oHOTp&Uw%0eb0M7=e!T&-)_Ds z?dZ{c2f~x3#J>j$Rf2>j~44(IM~t;Auw8o+*ps8lHQ^ zI?EHF@fCfUW4%(dtd=l?2oB-B4^&+*yxap;#n$8Kcid9hyqlUJk}`Q_XGYR;`td|$ z{oF?U6uav1G^S4kMO=(x3;A#%v*Z3@9* zAccNc$WL$KLsO!z`BGO`wTUfeW6&Y4);*Jccya43 z)Y9`ypudcqK-xUE6*zi(m(ucRda1`m+PUN2pZw605L+CZkZ13+A$v=M(;q90SA8X% z3YHzq1bkb3JY)$Ei})0vIr$r%3&%Sy-TU=H3drKvjRRt_GD+YIIkWfGoy4;fPdRH{ z%FNYXC3y~}&aeNTqYWnxAF_yZ4;~ccN?5zmDJTh^C^g$HcCz{WVvRZmDs?jmvsPIE zh1#Wib&QX`#M7)v)qma#i9G*4!+ejDo%QVP(C1etuaP9J$Tf*knu2hEvq2l5RMGPR zcfH4w^viq_!0Gu%^Tc00CpGUD=ZqZ=D$>7d2ch3rWSpJNWP7yV(tI^%a@T;%tj33u z!oczm+_JQQW~YlY(&$zw=CWAWVoDy@hQARm{GdwcV+X2mylLss(N`}b#OK3gt`B9Z zUP)RNEV4CY6pnNiCCKZFwaXjgLk0ZR8@6bpN}@)QSBATjH;CbWT_&-?8NJ@E19&~x zoBh>UO7|BS*^2eojhB+Nd$3kMw=@LepV)@}Vtc*$M$A4|8^Pu#QE1o$K5rUB>bmlU zYk_tWwTp_E5l4?{>@sW&980I)A15dzT%>UbJ}g8v`_pMQQ^~04Rv%A&{@evvx%Qj< zfoHBQcSQIs8Aw5Ji(Wy|_AG{v z-E^6zmQYKno+WT>x2Rn#Hd46UYM0NbFlbfE4ZTT4T%{=dvb~QzK0hS%(aGrwW8$GJ@ zvUTPd!0~#_e@fZ7&fLNYT_Pj7s8*E@3s@P;3nv2Sp)9umBTDF$SA;Wy)bbQ4+fA*Y z3yWy0ki7A+p1@`hMiR_Pzru57-Hj;WF-2^%_4>TKvlN>8)L=BFw4+36&@0QJhc?qk zDk7{(&lXxsh2l7001+HwF|kaE24CcSfq$ST zd|z+jdhX18vj||i0XV_L%noGpT9k7%?eVBu=(no&!ycz)p9{qw_fKCnN?x!T&W}op zQav_At&Kt{Gv@FU32rh|?7{Mghqt?URwy@ZbuSbw22!R$whB7gv9YL+pyI_}=&x<> z9PW8C4ii}Wq=9bNsgpUE8%A#pg&=QBcGlGPlMpp4lu=4mEq{yW^4u{0!&rJ@m0OfP zUyvMO?x^qj=f)_NejuJNdHl4-)Jdf$6{Yr(kc)L)Ho2VP{j<*k_$i_fI^yV9b+Kq= za)cL>=mQ7bCPr5tbtsSQopnz!_iEvRl~P`60QYr`#ISp?$?cVY0PYwE&#iOLQw|11 ztn`~%eyFnC(?fbZ8nhUgPct_Ak4XJ^hg|i1>7mK~8)*RzCd$LCg^pMe#Xi=up@SbWD)6AgmOQ!*r_KY1g&shWq1#{i~jH_=<+r6Sy|PJPsMR^Rj*BXuuj~`BQ=i!hxT6VAx+2eRF5Lw-Zj@Or-q5LOT@lg=8{5z)2(vVuA9q^XR5qZyyveANL)op@}T?7o%&!N z1Fu)ke0tcT1>`6zC4!)cGoIY{JN}tnOF}KW8^n^FklHY7iK+!O8 zf?dK4;(m5-KPb#_z7?R-kO0aJsQ_-ykcanzD@T^prU5cgsae)}tYc>$1k~q{2%C=h zC}Q^f$=Rk{;DBQO%higdK14C^yyXJ3i>B)WG~~v?^w2hnb(*^7O1yC*RBM(`mmM0Z|`&GYd}nP8WK;u6bx()jbYbN^Jd*- zz@M5-;jyi`S|P9@vC+672?YhVqqkrnI2rVxEA^~rKz`xeN2Jg7=B~V-Jl!};wm&z( zmkIuY5#QhQSC$MJ3=Tb|cm7Tn_hyjy$OMFU^}@#-;mdh$Rf_)pqjVYOHu*D@ zI)$16-a*I%?lj?Mshb z@eeQmfE0fEkq{FQzR4?lsW{mak>#>Inq93&_J&2zG1cAql^id zjVrrN)fSPiDDc&tZSH=H&Xqmgd;;;B)?*Sg;W`D!yO-p+A7+)-(L$b*^IF?)O-;k| zmr_)V+a))W;uF21U^Y^y_g24Yg()gf{ad{CJLXZZCLLM}&rTgA-su!3wxCTekKXmu zx9u`)FfHS6Z}k}qK@&4778+2fxGDq&K~(sdXSp`&q~b}nap`?NL2p0K4QvE1FYNl> zn*)*=4Z{GnWF*tLtF#Q>cTlmzci2XS<$Hl2d(JBrRyRM^3SXs71mHS7W_o+*ZOtsq z<&SfMu6N1AI$k%Ny{wO4*joJ;K6?DQNOqptLQJ;ee(p z0A57HLo7IufMO8yiwyf(YpBv#G~&g_nc9&2@PGXyz}XO8M>ntPO4X`kP&J}$ z%RXi_Bn_~eWnhF4mx23T2VsJVEPpAtZC~;w89XZx48$zAwzN#bJG~?O3Y=D{fv~@j z=OX@q8vkCInf*}=6AOZ47y|y*_D_2KS6h#P!bYK}A6C#0a<;9ugg8K)(Oy2l^|Pk8 z&y%QRP>@ik{ojJVJ@X$eXmN0e4khqv>iqVPjDH>F2%vBS*y1Ns@MDz=+AQoZB<`BN z+t!VrC$9p9cZT_^YT6m*ZNj)C&D+*|@D6Bv*E3A4JD{;mf$f0C4rpvcifzgN4K(0k zn;<487U>. Fill in the <>, then select *ES query*. - -[role="screenshot"] -image::user/alerting/images/alert-types-es-query-select.png[Choosing an ES query alert type] +Fill in the <>, then select *ES query*. [float] -==== Defining the conditions +==== Define the conditions -The ES query alert has 5 clauses that define the condition to detect. +Define properties to detect the condition. [role="screenshot"] -image::user/alerting/images/alert-types-es-query-conditions.png[Four clauses define the condition to detect] +image::user/alerting/images/alert-types-es-query-conditions.png[Five clauses define the condition to detect] Index:: This clause requires an *index or index pattern* and a *time field* that will be used for the *time window*. Size:: This clause specifies the number of documents to pass to the configured actions when the the threshold condition is met. @@ -29,9 +25,9 @@ Threshold:: This clause defines a threshold value and a comparison operator (`i Time window:: This clause determines how far back to search for documents, using the *time field* set in the *index* clause. Generally this value should be set to a value higher than the *check every* value in the <>, to avoid gaps in detection. [float] -==== Action variables +==== Add action variables -When the ES query alert condition is met, the following variables are available to use inside each action: +<> to run when the alert condition is met. The following variables are specific to the ES query alert. You can also specify <>. `context.title`:: A preconstructed title for the alert. Example: `alert term match alert query matched`. `context.message`:: A preconstructed message for the alert. Example: + @@ -45,22 +41,23 @@ When the ES query alert condition is met, the following variables are available `context.value`:: The value of the alert that met the condition. `context.conditions`:: A description of the condition. Example: `count greater than 4`. `context.hits`:: The most recent ES documents that matched the query. Using the https://mustache.github.io/[Mustache] template array syntax, you can iterate over these hits to get values from the ES documents into your actions. - ++ [role="screenshot"] image::images/alert-types-es-query-example-action-variable.png[Iterate over hits using Mustache template syntax] + [float] -==== Testing your query +==== Test your query Use the *Test query* feature to verify that your query DSL is valid. -When your query is valid:: Valid queries will be executed against the configured *index* using the configured *time window*. The number of documents that +* Valid queries are executed against the configured *index* using the configured *time window*. The number of documents that match the query will be displayed. - ++ [role="screenshot"] image::user/alerting/images/alert-types-es-query-valid.png[Test ES query returns number of matches when valid] -When your query is invalid:: An error message is shown if the query is invalid. - +* An error message is shown if the query is invalid. ++ [role="screenshot"] image::user/alerting/images/alert-types-es-query-invalid.png[Test ES query shows error when invalid] \ No newline at end of file diff --git a/docs/user/alerting/stack-alerts/index-threshold.asciidoc b/docs/user/alerting/stack-alerts/index-threshold.asciidoc index 6b45f69401c4a..89ca8e3087f12 100644 --- a/docs/user/alerting/stack-alerts/index-threshold.asciidoc +++ b/docs/user/alerting/stack-alerts/index-threshold.asciidoc @@ -2,20 +2,17 @@ [[alert-type-index-threshold]] === Index threshold -The index threshold alert type is designed to run an {es} query over indices, aggregating field values from documents, comparing them to threshold values, and scheduling actions to run when the thresholds are met. +The index threshold alert type runs an {es} query. It aggregates field values from documents, compares them to threshold values, and schedules actions to run when the thresholds are met. [float] -==== Creating the alert +==== Create the alert -An index threshold alert can be created from the *Create* button in the <>. Fill in the <>, then select *Index Threshold*. - -[role="screenshot"] -image::user/alerting/images/alert-types-index-threshold-select.png[Choosing an index threshold alert type] +Fill in the <>, then select *Index Threshold*. [float] -==== Defining the conditions +==== Define the conditions -The index threshold has 5 clauses that define the condition to detect. +Define properties to detect the condition. [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-conditions.png[Five clauses define the condition to detect] @@ -32,9 +29,9 @@ If data is available and all clauses have been defined, a preview chart will ren image::user/alerting/images/alert-types-index-threshold-preview.png[Five clauses define the condition to detect] [float] -==== Action variables +==== Add action variables -When the index threshold alert condition is met, the following variables are available to use inside each action: +<> to run when the alert condition is met. The following variables are specific to the index threshold alert. You can also specify <>. `context.title`:: A preconstructed title for the alert. Example: `alert kibana sites - high egress met threshold`. `context.message`:: A preconstructed message for the alert. Example: + @@ -51,68 +48,53 @@ When the index threshold alert condition is met, the following variables are ava [float] ==== Example -In this section, you will use the {kib} <> to setup and tune the conditions on an index threshold alert. For this example, we want to detect when any of our top three sites have served more than 420,000 bytes over a 24 hour period. +In this example, you will use the {kib} <> to set up and tune the conditions on an index threshold alert. For this example, you want to detect when any of the top four sites serve more than 420,000 bytes over a 24 hour period. -From the <>, create a new alert, and fill in the <>. This alert will be checked every 4 hours, and will not execute actions more than once per day. Choose the index threshold alert type. +. Open the main menu, then click **Stack Management > Alerts and Actions**. +. Create a new alert that is checked every four hours and executes actions when the alert status changes. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-select.png[Choosing an index threshold alert type] -Click on each clause to open a control that helps you set the value: - -[float] -==== Index clause -The index clause control will list and allow you to search for available indices. Choose *kibana_sample_data_logs* +. Select the **Index threshold** alert type. +. Click *Index*, and set *Indices to query* to *kibana_sample_data_logs*. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-index.png[Choosing an index] -Once an index is selected, the list of time fields for that index will be available to select. Choose *@timestamp*. - +. Set the *Time field* to *@timestamp*. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-timefield.png[Choosing a time field] -[float] -==== When clause - -We want to detect the number of bytes served during the time window, so we select `sum` as the aggregation, and `bytes` as the field to aggregate. - +. To detect the number of bytes served during the time window, click *When* and select `sum` as the aggregation, and bytes as the field to aggregate. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-aggregation.png[Choosing the aggregation] -[float] -==== Over/Grouped over clause - -We want to alert on the three sites that have the most traffic, so we'll group the sum of bytes by the `host.keyword` field and take the top 3 values. - +. To detect the four sites that have the most traffic, click *Over* and select `top`, enter `4`, and select `host.keyword` as the field. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-grouping.png[Choosing the groups] -[float] -==== Threshold clause - -We want to alert when any site exceeds 420,000 bytes over a 24 hour period, so we'll set the threshold to 420,000 and use the `is above` comparison. - +. To alert when any of the top four sites exceeds 420,000 bytes over a 24 hour period, select `is above` and enter `420000`. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-threshold.png[Setting the threshold] -[float] -==== Time window clause - -Finally, set the time window to 24 hours to complete the alert configuration. - +. Finally, click *For the last*, enter `24` and select `hours` to complete the alert configuration. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-window.png[Setting the time window] -The preview chart will render showing the 24 hour sum of bytes at 4 hours intervals (the *check every* interval) for the past 120 hours (the last 30 intervals). - +. The preview chart will render showing the 24 hour sum of bytes at 4 hours intervals (the *check every* interval) for the past 120 hours (the last 30 intervals). ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-preview.png[Setting the time window] -[float] -==== Comparing time windows - -You can interactively change the time window and observe the effect it has on the chart. Compare a 24 window to a 12 hour window. Notice the variability in the sum of bytes, due to different traffic levels during the day compared to at night. This variability would result in noisy alerts, so the 24 hour window is better. The preview chart can help you find the right values for your alert. - +. Change the time window and observe the effect it has on the chart. Compare a 24 window to a 12 hour window. Notice the variability in the sum of bytes, due to different traffic levels during the day compared to at night. This variability would result in noisy alerts, so the 24 hour window is better. The preview chart can help you find the right values for your alert. ++ [role="screenshot"] image::user/alerting/images/alert-types-index-threshold-example-comparison.png[Comparing two time windows] \ No newline at end of file diff --git a/x-pack/plugins/actions/README.md b/x-pack/plugins/actions/README.md index f1be1ec12b79c..3ec8545017ca1 100644 --- a/x-pack/plugins/actions/README.md +++ b/x-pack/plugins/actions/README.md @@ -434,7 +434,9 @@ Actions that take URLs or hostnames should check that those values are allowed. ## documentation -You should also create some asciidoc for the new action type. An entry should be made in the action type index - [`docs/user/alerting/action-types.asciidoc`](../../../docs/user/alerting/action-types.asciidoc) which points to a new document for the action type that should be in the directory [`docs/user/alerting/action-types`](../../../docs/user/alerting/action-types). +You should create asciidoc for the new action type. Add an entry to the action type index - [`docs/user/alerting/action-types.asciidoc`](../../../docs/user/alerting/action-types.asciidoc), which points to a new document for the action type that should be in the directory [`docs/user/alerting/action-types`](../../../docs/user/alerting/action-types). + +We suggest following the template provided in `docs/action-type-template.asciidoc`. The [Email action type](https://www.elastic.co/guide/en/kibana/master/email-action-type.html) is an example of documentation created following the template. ## tests diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md index 07bad42a3bfa3..057d86e4c0f31 100644 --- a/x-pack/plugins/alerts/README.md +++ b/x-pack/plugins/alerts/README.md @@ -19,9 +19,10 @@ Table of Contents - [Alert types](#alert-types) - [Methods](#methods) - [Executor](#executor) - - [Licensing](#licensing) - - [Documentation](#documentation) - - [Tests](#tests) + - [Action variables](#action-variables) + - [Licensing](#licensing) + - [Documentation](#documentation) + - [Tests](#tests) - [Example](#example) - [Role Based Access-Control](#role-based-access-control) - [Alert Navigation](#alert-navigation) @@ -147,9 +148,9 @@ This is the primary function for an alert type. Whenever the alert needs to exec |createdBy|The userid that created this alert.| |updatedBy|The userid that last updated this alert.| -### The `actionVariables` property +### Action Variables -This property should contain the **flattened** names of the state and context variables available when an executor calls `alertInstance.scheduleActions(actionGroup, context)`. These names are meant to be used in prompters in the alerting user interface, are used as text values for display, and can be inserted into to an action parameter text entry field via UI gesture (eg, clicking a menu item from a menu built with these names). They should be flattened, so if a state or context variable is an object with properties, these should be listed with the "parent" property/properties in the name, separated by a `.` (period). +The `actionVariables` property should contain the **flattened** names of the state and context variables available when an executor calls `alertInstance.scheduleActions(actionGroup, context)`. These names are meant to be used in prompters in the alerting user interface, are used as text values for display, and can be inserted into to an action parameter text entry field via UI gesture (eg, clicking a menu item from a menu built with these names). They should be flattened, so if a state or context variable is an object with properties, these should be listed with the "parent" property/properties in the name, separated by a `.` (period). For example, if the `context` has one variable `foo` which is an object that has one property `bar`, and there are no `state` variables, the `actionVariables` value would be in the following shape: @@ -167,7 +168,12 @@ Currently most of the alerts are free features. But some alert types are subscri ## Documentation -You should create documentation for the new alert type. Make an entry in the alert type index [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) that points to a new document for the alert type that should be in the proper application directory. +You should create asciidoc for the new alert type. +* For stack alerts, add an entry to the alert type index - [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) which points to a new document for the alert type that should be in the directory [`docs/user/alerting/stack-alerts`](../../../docs/user/alerting/stack-alerts). + +* Solution specific alert documentation should live within the docs for the solution. + +We suggest following the template provided in `docs/alert-type-template.asciidoc`. The [Index Threshold alert type](https://www.elastic.co/guide/en/kibana/master/alert-type-index-threshold.html) is an example of documentation created following the template. ## Tests From 57a860ddb01ba4afd69e6175098dcd5808ee8adf Mon Sep 17 00:00:00 2001 From: Spencer Date: Tue, 2 Mar 2021 18:29:54 -0700 Subject: [PATCH 14/52] [kbn/optimizer] allow customizing the limits path from the script (#93153) Co-authored-by: spalger Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- packages/kbn-optimizer/src/cli.ts | 318 ++++++++++-------- packages/kbn-optimizer/src/index.ts | 1 + packages/kbn-optimizer/src/limits.ts | 27 +- .../src/optimizer/optimizer_config.test.ts | 1 + .../src/optimizer/optimizer_config.ts | 5 +- scripts/build_kibana_platform_plugins.js | 4 +- .../tasks/build_kibana_platform_plugins.ts | 1 + 7 files changed, 200 insertions(+), 157 deletions(-) diff --git a/packages/kbn-optimizer/src/cli.ts b/packages/kbn-optimizer/src/cli.ts index 8fb906aa4603e..8f82f34646e60 100644 --- a/packages/kbn-optimizer/src/cli.ts +++ b/packages/kbn-optimizer/src/cli.ts @@ -12,164 +12,190 @@ import Path from 'path'; import { REPO_ROOT } from '@kbn/utils'; import { lastValueFrom } from '@kbn/std'; -import { run, createFlagError } from '@kbn/dev-utils'; +import { run, createFlagError, Flags } from '@kbn/dev-utils'; import { logOptimizerState } from './log_optimizer_state'; import { OptimizerConfig } from './optimizer'; import { runOptimizer } from './run_optimizer'; import { validateLimitsForAllBundles, updateBundleLimits } from './limits'; -run( - async ({ log, flags }) => { - const watch = flags.watch ?? false; - if (typeof watch !== 'boolean') { - throw createFlagError('expected --watch to have no value'); +function getLimitsPath(flags: Flags, defaultPath: string) { + if (flags.limits) { + if (typeof flags.limits !== 'string') { + throw createFlagError('expected --limits to be a string'); } - const oss = flags.oss ?? false; - if (typeof oss !== 'boolean') { - throw createFlagError('expected --oss to have no value'); - } - - const cache = flags.cache ?? true; - if (typeof cache !== 'boolean') { - throw createFlagError('expected --cache to have no value'); - } - - const includeCoreBundle = flags.core ?? true; - if (typeof includeCoreBundle !== 'boolean') { - throw createFlagError('expected --core to have no value'); - } - - const dist = flags.dist ?? false; - if (typeof dist !== 'boolean') { - throw createFlagError('expected --dist to have no value'); - } - - const examples = flags.examples ?? false; - if (typeof examples !== 'boolean') { - throw createFlagError('expected --no-examples to have no value'); - } - - const profileWebpack = flags.profile ?? false; - if (typeof profileWebpack !== 'boolean') { - throw createFlagError('expected --profile to have no value'); - } - - const inspectWorkers = flags['inspect-workers'] ?? false; - if (typeof inspectWorkers !== 'boolean') { - throw createFlagError('expected --no-inspect-workers to have no value'); - } - - const maxWorkerCount = flags.workers ? Number.parseInt(String(flags.workers), 10) : undefined; - if (maxWorkerCount !== undefined && (!Number.isFinite(maxWorkerCount) || maxWorkerCount < 1)) { - throw createFlagError('expected --workers to be a number greater than 0'); - } - - const extraPluginScanDirs = ([] as string[]) - .concat((flags['scan-dir'] as string | string[]) || []) - .map((p) => Path.resolve(p)); - if (!extraPluginScanDirs.every((s) => typeof s === 'string')) { - throw createFlagError('expected --scan-dir to be a string'); - } - - const reportStats = flags['report-stats'] ?? false; - if (typeof reportStats !== 'boolean') { - throw createFlagError('expected --report-stats to have no value'); - } - - const filter = typeof flags.filter === 'string' ? [flags.filter] : flags.filter; - if (!Array.isArray(filter) || !filter.every((f) => typeof f === 'string')) { - throw createFlagError('expected --filter to be one or more strings'); - } - - const focus = typeof flags.focus === 'string' ? [flags.focus] : flags.focus; - if (!Array.isArray(focus) || !focus.every((f) => typeof f === 'string')) { - throw createFlagError('expected --focus to be one or more strings'); - } + return Path.resolve(flags.limits); + } - const validateLimits = flags['validate-limits'] ?? false; - if (typeof validateLimits !== 'boolean') { - throw createFlagError('expected --validate-limits to have no value'); - } + if (process.env.KBN_OPTIMIZER_LIMITS_PATH) { + return Path.resolve(process.env.KBN_OPTIMIZER_LIMITS_PATH); + } - const updateLimits = flags['update-limits'] ?? false; - if (typeof updateLimits !== 'boolean') { - throw createFlagError('expected --update-limits to have no value'); - } + return defaultPath; +} + +export function runKbnOptimizerCli(options: { defaultLimitsPath: string }) { + run( + async ({ log, flags }) => { + const watch = flags.watch ?? false; + if (typeof watch !== 'boolean') { + throw createFlagError('expected --watch to have no value'); + } + + const oss = flags.oss ?? false; + if (typeof oss !== 'boolean') { + throw createFlagError('expected --oss to have no value'); + } + + const cache = flags.cache ?? true; + if (typeof cache !== 'boolean') { + throw createFlagError('expected --cache to have no value'); + } + + const includeCoreBundle = flags.core ?? true; + if (typeof includeCoreBundle !== 'boolean') { + throw createFlagError('expected --core to have no value'); + } + + const dist = flags.dist ?? false; + if (typeof dist !== 'boolean') { + throw createFlagError('expected --dist to have no value'); + } + + const examples = flags.examples ?? false; + if (typeof examples !== 'boolean') { + throw createFlagError('expected --no-examples to have no value'); + } + + const profileWebpack = flags.profile ?? false; + if (typeof profileWebpack !== 'boolean') { + throw createFlagError('expected --profile to have no value'); + } + + const inspectWorkers = flags['inspect-workers'] ?? false; + if (typeof inspectWorkers !== 'boolean') { + throw createFlagError('expected --no-inspect-workers to have no value'); + } + + const maxWorkerCount = flags.workers ? Number.parseInt(String(flags.workers), 10) : undefined; + if ( + maxWorkerCount !== undefined && + (!Number.isFinite(maxWorkerCount) || maxWorkerCount < 1) + ) { + throw createFlagError('expected --workers to be a number greater than 0'); + } + + const extraPluginScanDirs = ([] as string[]) + .concat((flags['scan-dir'] as string | string[]) || []) + .map((p) => Path.resolve(p)); + if (!extraPluginScanDirs.every((s) => typeof s === 'string')) { + throw createFlagError('expected --scan-dir to be a string'); + } + + const reportStats = flags['report-stats'] ?? false; + if (typeof reportStats !== 'boolean') { + throw createFlagError('expected --report-stats to have no value'); + } + + const filter = typeof flags.filter === 'string' ? [flags.filter] : flags.filter; + if (!Array.isArray(filter) || !filter.every((f) => typeof f === 'string')) { + throw createFlagError('expected --filter to be one or more strings'); + } + + const focus = typeof flags.focus === 'string' ? [flags.focus] : flags.focus; + if (!Array.isArray(focus) || !focus.every((f) => typeof f === 'string')) { + throw createFlagError('expected --focus to be one or more strings'); + } + + const limitsPath = getLimitsPath(flags, options.defaultLimitsPath); + + const validateLimits = flags['validate-limits'] ?? false; + if (typeof validateLimits !== 'boolean') { + throw createFlagError('expected --validate-limits to have no value'); + } + + const updateLimits = flags['update-limits'] ?? false; + if (typeof updateLimits !== 'boolean') { + throw createFlagError('expected --update-limits to have no value'); + } + + const config = OptimizerConfig.create({ + repoRoot: REPO_ROOT, + watch, + maxWorkerCount, + oss: oss && !(validateLimits || updateLimits), + dist: dist || updateLimits, + cache, + examples: examples && !(validateLimits || updateLimits), + profileWebpack, + extraPluginScanDirs, + inspectWorkers, + includeCoreBundle, + filter, + focus, + limitsPath, + }); - const config = OptimizerConfig.create({ - repoRoot: REPO_ROOT, - watch, - maxWorkerCount, - oss: oss && !(validateLimits || updateLimits), - dist: dist || updateLimits, - cache, - examples: examples && !(validateLimits || updateLimits), - profileWebpack, - extraPluginScanDirs, - inspectWorkers, - includeCoreBundle, - filter, - focus, - }); - - if (validateLimits) { - validateLimitsForAllBundles(log, config); - return; - } + if (validateLimits) { + validateLimitsForAllBundles(log, config, limitsPath); + return; + } - const update$ = runOptimizer(config); + const update$ = runOptimizer(config); - await lastValueFrom(update$.pipe(logOptimizerState(log, config))); + await lastValueFrom(update$.pipe(logOptimizerState(log, config))); - if (updateLimits) { - updateBundleLimits({ - log, - config, - dropMissing: !(focus || filter), - }); - } - }, - { - flags: { - boolean: [ - 'core', - 'watch', - 'oss', - 'examples', - 'dist', - 'cache', - 'profile', - 'inspect-workers', - 'validate-limits', - 'update-limits', - ], - string: ['workers', 'scan-dir', 'filter'], - default: { - core: true, - examples: true, - cache: true, - 'inspect-workers': true, - filter: [], - focus: [], - }, - help: ` - --watch run the optimizer in watch mode - --workers max number of workers to use - --oss only build oss plugins - --profile profile the webpack builds and write stats.json files to build outputs - --no-core disable generating the core bundle - --no-cache disable the cache - --focus just like --filter, except dependencies are automatically included, --filter applies to result - --filter comma-separated list of bundle id filters, results from multiple flags are merged, * and ! are supported - --no-examples don't build the example plugins - --dist create bundles that are suitable for inclusion in the Kibana distributable, enabled when running with --update-limits - --scan-dir add a directory to the list of directories scanned for plugins (specify as many times as necessary) - --no-inspect-workers when inspecting the parent process, don't inspect the workers - --validate-limits validate the limits.yml config to ensure that there are limits defined for every bundle - --update-limits run a build and rewrite the limits file to include the current bundle sizes +5kb - `, + if (updateLimits) { + updateBundleLimits({ + log, + config, + dropMissing: !(focus || filter), + limitsPath, + }); + } }, - } -); + { + flags: { + boolean: [ + 'core', + 'watch', + 'oss', + 'examples', + 'dist', + 'cache', + 'profile', + 'inspect-workers', + 'validate-limits', + 'update-limits', + ], + string: ['workers', 'scan-dir', 'filter', 'limits'], + default: { + core: true, + examples: true, + cache: true, + 'inspect-workers': true, + filter: [], + focus: [], + }, + help: ` + --watch run the optimizer in watch mode + --workers max number of workers to use + --oss only build oss plugins + --profile profile the webpack builds and write stats.json files to build outputs + --no-core disable generating the core bundle + --no-cache disable the cache + --focus just like --filter, except dependencies are automatically included, --filter applies to result + --filter comma-separated list of bundle id filters, results from multiple flags are merged, * and ! are supported + --no-examples don't build the example plugins + --dist create bundles that are suitable for inclusion in the Kibana distributable, enabled when running with --update-limits + --scan-dir add a directory to the list of directories scanned for plugins (specify as many times as necessary) + --no-inspect-workers when inspecting the parent process, don't inspect the workers + --limits path to a limits.yml file to read, defaults to $KBN_OPTIMIZER_LIMITS_PATH or source file + --validate-limits validate the limits.yml config to ensure that there are limits defined for every bundle + --update-limits run a build and rewrite the limits file to include the current bundle sizes +5kb + `, + }, + } + ); +} diff --git a/packages/kbn-optimizer/src/index.ts b/packages/kbn-optimizer/src/index.ts index 551d2ffacfcfb..8d6e89008bc68 100644 --- a/packages/kbn-optimizer/src/index.ts +++ b/packages/kbn-optimizer/src/index.ts @@ -11,3 +11,4 @@ export * from './run_optimizer'; export * from './log_optimizer_state'; export * from './node'; export * from './limits'; +export * from './cli'; diff --git a/packages/kbn-optimizer/src/limits.ts b/packages/kbn-optimizer/src/limits.ts index 292314a4608e4..077fe38ddc7f6 100644 --- a/packages/kbn-optimizer/src/limits.ts +++ b/packages/kbn-optimizer/src/limits.ts @@ -15,15 +15,14 @@ import { createFailError, ToolingLog, CiStatsMetrics } from '@kbn/dev-utils'; import { OptimizerConfig, Limits } from './optimizer'; -const LIMITS_PATH = require.resolve('../limits.yml'); const DEFAULT_BUDGET = 15000; const diff = (a: T[], b: T[]): T[] => a.filter((item) => !b.includes(item)); -export function readLimits(): Limits { +export function readLimits(path: string): Limits { let yaml; try { - yaml = Fs.readFileSync(LIMITS_PATH, 'utf8'); + yaml = Fs.readFileSync(path, 'utf8'); } catch (error) { if (error.code !== 'ENOENT') { throw error; @@ -33,8 +32,12 @@ export function readLimits(): Limits { return yaml ? Yaml.safeLoad(yaml) : {}; } -export function validateLimitsForAllBundles(log: ToolingLog, config: OptimizerConfig) { - const limitBundleIds = Object.keys(readLimits().pageLoadAssetSize || {}); +export function validateLimitsForAllBundles( + log: ToolingLog, + config: OptimizerConfig, + limitsPath: string +) { + const limitBundleIds = Object.keys(readLimits(limitsPath).pageLoadAssetSize || {}); const configBundleIds = config.bundles.map((b) => b.id); const missingBundleIds = diff(configBundleIds, limitBundleIds); @@ -73,10 +76,16 @@ interface UpdateBundleLimitsOptions { log: ToolingLog; config: OptimizerConfig; dropMissing: boolean; + limitsPath: string; } -export function updateBundleLimits({ log, config, dropMissing }: UpdateBundleLimitsOptions) { - const limits = readLimits(); +export function updateBundleLimits({ + log, + config, + dropMissing, + limitsPath, +}: UpdateBundleLimitsOptions) { + const limits = readLimits(limitsPath); const metrics: CiStatsMetrics = config.bundles .map((bundle) => JSON.parse(Fs.readFileSync(Path.resolve(bundle.outputDir, 'metrics.json'), 'utf-8')) @@ -102,6 +111,6 @@ export function updateBundleLimits({ log, config, dropMissing }: UpdateBundleLim pageLoadAssetSize, }; - Fs.writeFileSync(LIMITS_PATH, Yaml.safeDump(newLimits)); - log.success(`wrote updated limits to ${LIMITS_PATH}`); + Fs.writeFileSync(limitsPath, Yaml.safeDump(newLimits)); + log.success(`wrote updated limits to ${limitsPath}`); } diff --git a/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts b/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts index c60d6719cdea7..c546a0c6cf992 100644 --- a/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts +++ b/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts @@ -427,6 +427,7 @@ describe('OptimizerConfig::create()', () => { it('passes parsed options to findKibanaPlatformPlugins, getBundles, and assignBundlesToWorkers', () => { const config = OptimizerConfig.create({ repoRoot: REPO_ROOT, + limitsPath: '/foo/limits.yml', }); expect(config).toMatchInlineSnapshot(` diff --git a/packages/kbn-optimizer/src/optimizer/optimizer_config.ts b/packages/kbn-optimizer/src/optimizer/optimizer_config.ts index ed521d32a0a29..9110b6db27e92 100644 --- a/packages/kbn-optimizer/src/optimizer/optimizer_config.ts +++ b/packages/kbn-optimizer/src/optimizer/optimizer_config.ts @@ -115,6 +115,9 @@ interface Options { * - "k7light" */ themes?: ThemeTag | '*' | ThemeTag[]; + + /** path to a limits.yml file that should be used to inform ci-stats of metric limits */ + limitsPath?: string; } export interface ParsedOptions { @@ -211,7 +214,7 @@ export class OptimizerConfig { } static create(inputOptions: Options) { - const limits = readLimits(); + const limits = inputOptions.limitsPath ? readLimits(inputOptions.limitsPath) : {}; const options = OptimizerConfig.parseOptions(inputOptions); const plugins = findKibanaPlatformPlugins(options.pluginScanDirs, options.pluginPaths); const bundles = [ diff --git a/scripts/build_kibana_platform_plugins.js b/scripts/build_kibana_platform_plugins.js index b562183dd19f5..809e21bc652d0 100644 --- a/scripts/build_kibana_platform_plugins.js +++ b/scripts/build_kibana_platform_plugins.js @@ -6,4 +6,6 @@ * Side Public License, v 1. */ -require('@kbn/optimizer/target/cli'); +require('@kbn/optimizer').runKbnOptimizerCli({ + defaultLimitsPath: require.resolve('../packages/kbn-optimizer/limits.yml'), +}); diff --git a/src/dev/build/tasks/build_kibana_platform_plugins.ts b/src/dev/build/tasks/build_kibana_platform_plugins.ts index d2d2d3275270b..dfac3edf9847b 100644 --- a/src/dev/build/tasks/build_kibana_platform_plugins.ts +++ b/src/dev/build/tasks/build_kibana_platform_plugins.ts @@ -27,6 +27,7 @@ export const BuildKibanaPlatformPlugins: Task = { watch: false, dist: true, includeCoreBundle: true, + limitsPath: Path.resolve(REPO_ROOT, 'packages/kbn-optimizer/limits.yml'), }); await lastValueFrom(runOptimizer(config).pipe(logOptimizerState(log, config))); From bd9b349dfda8df04c89c133af3b4280f69bf0de2 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 2 Mar 2021 19:07:03 -0700 Subject: [PATCH 15/52] rename advanced setting ml:fileDataVisualizerMaxFileSize to fileUpload:maxFileSize and increase max geojson upload size to 1GB (#92620) * rename ml:fileDataVisualizerMaxFileSize to fileUppload:maxFileSize * add saved object migration * file preview * importing status * remove console statement * import complete view * fix geojson_importer test * tslint * i18n fixes * cleanup * update documenation for advanced setting rename * advanced settings usage_collection * remove ml:fileDataVisualizerMaxFileSize from schemas and types * add copy buttons for import response and fix geojson upload functional tests * tslint * remove clipboard-read check * return early if env does not support reading from clipboard * fix reporting tests * review feedback * update GeoJsonFileSource to support showing results trimmed icon and tooltip * add fileUpload to useMlKibana context and replace dependencyCache with useMlKibana * tslint * review feedback * lower case file name * default to selecting geo_shape when file contains both points and shapes * fix wizard onError callback to not advance to next step Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- docs/management/advanced-options.asciidoc | 10 +- docs/user/ml/index.asciidoc | 28 +- .../saved_objects/migrations.test.ts | 34 ++ .../ui_settings/saved_objects/migrations.ts | 19 + .../server/collectors/management/schema.ts | 2 +- .../server/collectors/management/types.ts | 2 +- src/plugins/telemetry/schema/oss_plugins.json | 2 +- .../plugins/file_upload/common/constants.ts | 2 + x-pack/plugins/file_upload/kibana.json | 3 +- .../plugins/file_upload/public/api/index.ts | 2 + .../public/components/geojson_file_picker.tsx | 155 ++++++++ .../components/import_complete_view.tsx | 159 ++++++++ .../public/components/index_settings.js | 1 + .../public/components/json_import_progress.js | 135 ------- .../components/json_index_file_picker.js | 267 ------------- .../components/json_upload_and_parse.js | 369 ++++++++---------- .../file_upload/public/get_max_bytes.ts | 31 ++ .../geojson_importer/geojson_importer.test.js | 130 +++--- .../geojson_importer/geojson_importer.ts | 354 +++++++++++------ .../public/importer/geojson_importer/index.ts | 2 +- .../file_upload/public/importer/importer.ts | 4 +- .../file_upload/public/importer/index.ts | 1 + .../public/importer/validate_file.ts | 52 +++ .../file_upload/public/kibana_services.ts | 1 + .../public/lazy_load_bundle/index.ts | 2 +- x-pack/plugins/file_upload/public/plugin.ts | 3 + x-pack/plugins/file_upload/server/plugin.ts | 23 ++ .../source_descriptor_types.ts | 2 + .../layers/file_upload_wizard/wizard.tsx | 17 +- .../geojson_file_source.ts | 10 + .../plugins/ml/common/constants/settings.ts | 1 - x-pack/plugins/ml/public/application/app.tsx | 1 + .../contexts/kibana/kibana_context.ts | 2 + .../datavisualizer_selector.tsx | 11 +- .../about_panel/welcome_content.tsx | 14 +- .../file_datavisualizer_view.js | 4 +- .../file_based/components/utils/index.ts | 2 - .../file_based/components/utils/utils.ts | 26 +- .../ml/server/lib/register_settings.ts | 20 - .../translations/translations/ja-JP.json | 23 -- .../translations/translations/zh-CN.json | 23 -- .../import_geojson/file_indexing_panel.js | 7 + .../reporting/ecommerce_kibana/data.json | 31 ++ .../reporting/ecommerce_kibana/data.json.gz | Bin 4526 -> 0 bytes .../ecommerce_kibana_spaces/data.json | 362 +++++++++++++++++ .../ecommerce_kibana_spaces/data.json.gz | Bin 2354 -> 0 bytes .../test/functional/page_objects/gis_page.ts | 19 +- 47 files changed, 1428 insertions(+), 940 deletions(-) create mode 100644 x-pack/plugins/file_upload/public/components/geojson_file_picker.tsx create mode 100644 x-pack/plugins/file_upload/public/components/import_complete_view.tsx delete mode 100644 x-pack/plugins/file_upload/public/components/json_import_progress.js delete mode 100644 x-pack/plugins/file_upload/public/components/json_index_file_picker.js create mode 100644 x-pack/plugins/file_upload/public/get_max_bytes.ts create mode 100644 x-pack/plugins/file_upload/public/importer/validate_file.ts create mode 100644 x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json delete mode 100644 x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json.gz create mode 100644 x-pack/test/functional/es_archives/reporting/ecommerce_kibana_spaces/data.json delete mode 100644 x-pack/test/functional/es_archives/reporting/ecommerce_kibana_spaces/data.json.gz diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index c7d5242da69de..3ee7a0471eec1 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -83,6 +83,10 @@ specific dashboard, application, or saved object as they enter each space. [[fields-popularlimit]]`fields:popularLimit`:: The top N most popular fields to show. +[[fileupload-maxfilesize]]`fileUpload:maxFileSize`:: +Sets the file size limit when importing files. The default +value is `100MB`. The highest supported value for this setting is `1GB`. + [[filtereditor-suggestvalues]]`filterEditor:suggestValues`:: Set this property to `false` to prevent the filter editor from suggesting values for fields. @@ -257,7 +261,7 @@ Hides the "Time" column in *Discover* and in all saved searches on dashboards. Highlights results in *Discover* and saved searches on dashboards. Highlighting slows requests when working on big documents. -[[doctable-legacy]]`doc_table:legacy`:: +[[doctable-legacy]]`doc_table:legacy`:: Controls the way the document table looks and works. Set this property to `true` to revert to the legacy implementation. [[discover-searchFieldsFromSource]]`discover:searchFieldsFromSource`:: @@ -281,10 +285,6 @@ must contain `from` and `to` values (see {ref}/common-options.html#date-math[accepted formats]). It is ignored unless `ml:anomalyDetection:results:enableTimeDefaults` is enabled. -[[ml-filedatavisualizermaxfilesize]]`ml:fileDataVisualizerMaxFileSize`:: -Sets the file size limit when importing data in the {data-viz}. The default -value is `100MB`. The highest supported value for this setting is `1GB`. - [float] [[kibana-notification-settings]] diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index fa15e0652e2ab..3c463da842faa 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -20,10 +20,10 @@ image::user/ml/images/ml-data-visualizer-sample.jpg[{data-viz} for sample flight experimental[] You can also upload a CSV, NDJSON, or log file. The *{data-viz}* identifies the file format and field mappings. You can then optionally import that data into an {es} index. To change the default file size limit, see -<>. +<>. If {stack-security-features} are enabled, users must have the necessary -privileges to use {ml-features}. Refer to +privileges to use {ml-features}. Refer to {ml-docs}/setup.html#setup-privileges[Set up {ml-features}]. NOTE: There are limitations in {ml-features} that affect {kib}. For more information, refer to {ml-docs}/ml-limitations.html[Machine learning]. @@ -40,15 +40,15 @@ false positives. {anomaly-detect-cap} runs in and scales with {es}, and includes an intuitive UI on the {kib} *Machine Learning* page for creating {anomaly-jobs} and understanding results. -If you have a license that includes the {ml-features}, you can +If you have a license that includes the {ml-features}, you can create {anomaly-jobs} and manage jobs and {dfeeds} from the *Job Management* -pane: +pane: [role="screenshot"] image::user/ml/images/ml-job-management.png[Job Management] -You can use the *Settings* pane to create and edit -{ml-docs}/ml-calendars.html[calendars] and the filters that are used in +You can use the *Settings* pane to create and edit +{ml-docs}/ml-calendars.html[calendars] and the filters that are used in {ml-docs}/ml-rules.html[custom rules]: [role="screenshot"] @@ -69,13 +69,13 @@ occurring in your operational environment at that time: image::user/ml/images/ml-annotations-list.png[Single Metric Viewer with annotations] In some circumstances, annotations are also added automatically. For example, if -the {anomaly-job} detects that there is missing data, it annotates the affected -time period. For more information, see -{ml-docs}/ml-delayed-data-detection.html[Handling delayed data]. The +the {anomaly-job} detects that there is missing data, it annotates the affected +time period. For more information, see +{ml-docs}/ml-delayed-data-detection.html[Handling delayed data]. The *Job Management* pane shows the full list of annotations for each job. -NOTE: The {kib} {ml-features} use pop-ups. You must configure your web -browser so that it does not block pop-up windows or create an exception for your +NOTE: The {kib} {ml-features} use pop-ups. You must configure your web +browser so that it does not block pop-up windows or create an exception for your {kib} URL. For more information about the {anomaly-detect} feature, see @@ -89,7 +89,7 @@ experimental[] The Elastic {ml} {dfanalytics} feature enables you to analyze your data using {classification}, {oldetection}, and {regression} algorithms and generate new -indices that contain the results alongside your source data. +indices that contain the results alongside your source data. If you have a license that includes the {ml-features}, you can create {dfanalytics-jobs} and view their results on the *Data Frame Analytics* page in @@ -98,5 +98,5 @@ If you have a license that includes the {ml-features}, you can create [role="screenshot"] image::user/ml/images/outliers.png[{oldetection-cap} results in {kib}] -For more information about the {dfanalytics} feature, see -{ml-docs}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file +For more information about the {dfanalytics} feature, see +{ml-docs}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. diff --git a/src/core/server/ui_settings/saved_objects/migrations.test.ts b/src/core/server/ui_settings/saved_objects/migrations.test.ts index ea5b4133b49c3..7b53f4e21dd9b 100644 --- a/src/core/server/ui_settings/saved_objects/migrations.test.ts +++ b/src/core/server/ui_settings/saved_objects/migrations.test.ts @@ -44,3 +44,37 @@ describe('ui_settings 7.9.0 migrations', () => { }); }); }); + +describe('ui_settings 7.13.0 migrations', () => { + const migration = migrations['7.13.0']; + + test('returns doc on empty object', () => { + expect(migration({} as SavedObjectUnsanitizedDoc)).toEqual({ + references: [], + }); + }); + test('properly renames ml:fileDataVisualizerMaxFileSize to fileUpload:maxFileSize', () => { + const doc = { + type: 'config', + id: '8.0.0', + attributes: { + buildNum: 9007199254740991, + 'ml:fileDataVisualizerMaxFileSize': '250MB', + }, + references: [], + updated_at: '2020-06-09T20:18:20.349Z', + migrationVersion: {}, + }; + expect(migration(doc)).toEqual({ + type: 'config', + id: '8.0.0', + attributes: { + buildNum: 9007199254740991, + 'fileUpload:maxFileSize': '250MB', + }, + references: [], + updated_at: '2020-06-09T20:18:20.349Z', + migrationVersion: {}, + }); + }); +}); diff --git a/src/core/server/ui_settings/saved_objects/migrations.ts b/src/core/server/ui_settings/saved_objects/migrations.ts index 7ea5573076ba0..b5dc13fcdae3b 100644 --- a/src/core/server/ui_settings/saved_objects/migrations.ts +++ b/src/core/server/ui_settings/saved_objects/migrations.ts @@ -28,4 +28,23 @@ export const migrations = { }), references: doc.references || [], }), + '7.13.0': (doc: SavedObjectUnsanitizedDoc): SavedObjectSanitizedDoc => ({ + ...doc, + ...(doc.attributes && { + attributes: Object.keys(doc.attributes).reduce( + (acc, key) => + key === 'ml:fileDataVisualizerMaxFileSize' + ? { + ...acc, + ['fileUpload:maxFileSize']: doc.attributes[key], + } + : { + ...acc, + [key]: doc.attributes[key], + }, + {} + ), + }), + references: doc.references || [], + }), }; diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts index 507eb3e545087..f166e4fcebfa3 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts @@ -216,7 +216,7 @@ export const stackManagementSchema: MakeSchemaFrom = { type: 'boolean', _meta: { description: 'Non-default value of setting.' }, }, - 'ml:fileDataVisualizerMaxFileSize': { + 'fileUpload:maxFileSize': { type: 'keyword', _meta: { description: 'Non-default value of setting.' }, }, diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/types.ts b/src/plugins/kibana_usage_collection/server/collectors/management/types.ts index 698e7e7115295..8bbc14e0678d3 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/management/types.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/management/types.ts @@ -73,7 +73,7 @@ export interface UsageStats { 'discover:sort:defaultOrder': string; 'context:step': number; 'accessibility:disableAnimations': boolean; - 'ml:fileDataVisualizerMaxFileSize': string; + 'fileUpload:maxFileSize': string; 'ml:anomalyDetection:results:enableTimeDefaults': boolean; 'ml:anomalyDetection:results:timeDefaults': string; 'truncate:maxHeight': number; diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json index 1d0639afcd6c6..f7795dbf9b2f8 100644 --- a/src/plugins/telemetry/schema/oss_plugins.json +++ b/src/plugins/telemetry/schema/oss_plugins.json @@ -7736,7 +7736,7 @@ "description": "Non-default value of setting." } }, - "ml:fileDataVisualizerMaxFileSize": { + "fileUpload:maxFileSize": { "type": "keyword", "_meta": { "description": "Non-default value of setting." diff --git a/x-pack/plugins/file_upload/common/constants.ts b/x-pack/plugins/file_upload/common/constants.ts index 11ad80f5c955e..ea36e51466703 100644 --- a/x-pack/plugins/file_upload/common/constants.ts +++ b/x-pack/plugins/file_upload/common/constants.ts @@ -5,6 +5,8 @@ * 2.0. */ +export const UI_SETTING_MAX_FILE_SIZE = 'fileUpload:maxFileSize'; + export const MB = Math.pow(2, 20); export const MAX_FILE_SIZE = '100MB'; export const MAX_FILE_SIZE_BYTES = 104857600; // 100MB diff --git a/x-pack/plugins/file_upload/kibana.json b/x-pack/plugins/file_upload/kibana.json index 7676a01d0b0f9..6d55e4f46d7e8 100644 --- a/x-pack/plugins/file_upload/kibana.json +++ b/x-pack/plugins/file_upload/kibana.json @@ -4,5 +4,6 @@ "kibanaVersion": "kibana", "server": true, "ui": true, - "requiredPlugins": ["data", "usageCollection"] + "requiredPlugins": ["data", "usageCollection"], + "requiredBundles": ["kibanaReact"] } diff --git a/x-pack/plugins/file_upload/public/api/index.ts b/x-pack/plugins/file_upload/public/api/index.ts index 359bc4a1687b5..8884c398fa2e6 100644 --- a/x-pack/plugins/file_upload/public/api/index.ts +++ b/x-pack/plugins/file_upload/public/api/index.ts @@ -12,6 +12,8 @@ import type { IImporter, ImportFactoryOptions } from '../importer'; export interface FileUploadStartApi { getFileUploadComponent(): Promise>; importerFactory(format: string, options: ImportFactoryOptions): Promise; + getMaxBytes(): number; + getMaxBytesFormatted(): string; } export async function getFileUploadComponent(): Promise< diff --git a/x-pack/plugins/file_upload/public/components/geojson_file_picker.tsx b/x-pack/plugins/file_upload/public/components/geojson_file_picker.tsx new file mode 100644 index 0000000000000..724a23a43202f --- /dev/null +++ b/x-pack/plugins/file_upload/public/components/geojson_file_picker.tsx @@ -0,0 +1,155 @@ +/* + * 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 React, { Component } from 'react'; +import { EuiFilePicker, EuiFormRow } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { MB } from '../../common'; +import { getMaxBytesFormatted } from '../get_max_bytes'; +import { validateFile } from '../importer'; +import { GeoJsonImporter, GeoJsonPreview, GEOJSON_FILE_TYPES } from '../importer/geojson_importer'; + +interface Props { + onSelect: ({ + features, + hasPoints, + hasShapes, + importer, + indexName, + previewCoverage, + }: GeoJsonPreview & { + indexName: string; + importer: GeoJsonImporter; + }) => void; + onClear: () => void; +} + +interface State { + error: string | null; + isLoadingPreview: boolean; + previewSummary: string | null; +} + +export class GeoJsonFilePicker extends Component { + private _isMounted = false; + + state: State = { + error: null, + isLoadingPreview: false, + previewSummary: null, + }; + + async componentDidMount() { + this._isMounted = true; + } + + componentWillUnmount() { + this._isMounted = false; + } + + _onFileSelect = (files: FileList | null) => { + this.props.onClear(); + + this.setState({ + error: null, + isLoadingPreview: false, + previewSummary: null, + }); + + if (files && files.length) { + this._loadFilePreview(files[0]); + } + }; + + async _loadFilePreview(file: File) { + this.setState({ isLoadingPreview: true }); + + let importer: GeoJsonImporter | null = null; + let previewError: string | null = null; + let preview: GeoJsonPreview | null = null; + try { + validateFile(file, GEOJSON_FILE_TYPES); + importer = new GeoJsonImporter(file); + preview = await importer.previewFile(10000, MB * 3); + if (preview.features.length === 0) { + previewError = i18n.translate('xpack.fileUpload.geojsonFilePicker.noFeaturesDetected', { + defaultMessage: 'No GeoJson features found in selected file.', + }); + } + } catch (error) { + previewError = error.message; + } + + if (!this._isMounted) { + return; + } + + this.setState({ + error: previewError, + isLoadingPreview: false, + previewSummary: + !previewError && preview + ? i18n.translate('xpack.fileUpload.geojsonFilePicker.previewSummary', { + defaultMessage: 'Previewing {numFeatures} features, {previewCoverage}% of file.', + values: { + numFeatures: preview.features.length, + previewCoverage: preview.previewCoverage, + }, + }) + : null, + }); + + if (importer && preview) { + this.props.onSelect({ + ...preview, + importer, + indexName: file.name.split('.')[0].toLowerCase(), + }); + } + } + + _renderHelpText() { + return this.state.previewSummary !== null ? ( + this.state.previewSummary + ) : ( + + {i18n.translate('xpack.fileUpload.geojsonFilePicker.acceptedFormats', { + defaultMessage: 'Formats accepted: {fileTypes}', + values: { fileTypes: GEOJSON_FILE_TYPES.join(', ') }, + })} +
+ {i18n.translate('xpack.fileUpload.geojsonFilePicker.maxSize', { + defaultMessage: 'Max size: {maxFileSize}', + values: { maxFileSize: getMaxBytesFormatted() }, + })} +
+ {i18n.translate('xpack.fileUpload.geojsonFilePicker.acceptedCoordinateSystem', { + defaultMessage: 'Coordinates must be in EPSG:4326 coordinate reference system.', + })} + + ); + } + + render() { + return ( + + + + ); + } +} diff --git a/x-pack/plugins/file_upload/public/components/import_complete_view.tsx b/x-pack/plugins/file_upload/public/components/import_complete_view.tsx new file mode 100644 index 0000000000000..c6209ae765c72 --- /dev/null +++ b/x-pack/plugins/file_upload/public/components/import_complete_view.tsx @@ -0,0 +1,159 @@ +/* + * 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 React, { Component, Fragment } from 'react'; +import { i18n } from '@kbn/i18n'; +import { + EuiButtonIcon, + EuiCallOut, + EuiCopy, + EuiFlexGroup, + EuiFlexItem, + EuiSpacer, + EuiText, + EuiTitle, +} from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n/react'; +import { CodeEditor, KibanaContextProvider } from '../../../../../src/plugins/kibana_react/public'; +import { getHttp, getUiSettings } from '../kibana_services'; +import { ImportResponse } from '../../common'; + +const services = { + uiSettings: getUiSettings(), +}; + +interface Props { + importResp?: ImportResponse; + indexPatternResp?: object; +} + +export class ImportCompleteView extends Component { + _renderCodeEditor(json: object | undefined, title: string, copyButtonDataTestSubj: string) { + if (!json) { + return null; + } + + const jsonAsString = JSON.stringify(json, null, 2); + + return ( + + + + +

{title}

+ + + + + + {(copy) => ( + + )} + + + +
+ {}} + options={{ + readOnly: true, + lineNumbers: 'off', + fontSize: 12, + minimap: { + enabled: false, + }, + scrollBeyondLastLine: false, + wordWrap: 'on', + wrappingIndent: 'indent', + automaticLayout: true, + }} + /> +
+ + + ); + } + + _getStatusMsg() { + if (!this.props.importResp || !this.props.importResp.success) { + return i18n.translate('xpack.fileUpload.uploadFailureMsg', { + defaultMessage: 'File upload failed.', + }); + } + + const successMsg = i18n.translate('xpack.fileUpload.uploadSuccessMsg', { + defaultMessage: 'File upload complete: indexed {numFeatures} features.', + values: { + numFeatures: this.props.importResp.docCount, + }, + }); + + const failedFeaturesMsg = this.props.importResp.failures.length + ? i18n.translate('xpack.fileUpload.failedFeaturesMsg', { + defaultMessage: 'Unable to index {numFailures} features.', + values: { + numFailures: this.props.importResp.failures.length, + }, + }) + : ''; + + return `${successMsg} ${failedFeaturesMsg}`; + } + + render() { + return ( + + +

{this._getStatusMsg()}

+ + {this._renderCodeEditor( + this.props.importResp, + i18n.translate('xpack.fileUpload.jsonImport.indexingResponse', { + defaultMessage: 'Import response', + }), + 'indexRespCopyButton' + )} + {this._renderCodeEditor( + this.props.indexPatternResp, + i18n.translate('xpack.fileUpload.jsonImport.indexPatternResponse', { + defaultMessage: 'Index pattern response', + }), + 'indexPatternRespCopyButton' + )} + + + + + ); + } +} diff --git a/x-pack/plugins/file_upload/public/components/index_settings.js b/x-pack/plugins/file_upload/public/components/index_settings.js index 3cad31cdbe3df..7d7ab3516e651 100644 --- a/x-pack/plugins/file_upload/public/components/index_settings.js +++ b/x-pack/plugins/file_upload/public/components/index_settings.js @@ -118,6 +118,7 @@ export class IndexSettings extends Component { text: indexType, value: indexType, }))} + value={this.props.selectedIndexType} onChange={({ target }) => setSelectedIndexType(target.value)} /> diff --git a/x-pack/plugins/file_upload/public/components/json_import_progress.js b/x-pack/plugins/file_upload/public/components/json_import_progress.js deleted file mode 100644 index 1adf7d9039e56..0000000000000 --- a/x-pack/plugins/file_upload/public/components/json_import_progress.js +++ /dev/null @@ -1,135 +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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { Fragment, Component } from 'react'; -import { i18n } from '@kbn/i18n'; -import { EuiCodeBlock, EuiSpacer, EuiText, EuiTitle, EuiProgress, EuiCallOut } from '@elastic/eui'; -import { FormattedMessage } from '@kbn/i18n/react'; -import { getHttp } from '../kibana_services'; - -export class JsonImportProgress extends Component { - state = { - indexDataJson: null, - indexPatternJson: null, - indexName: '', - importStage: '', - }; - - componentDidUpdate(prevProps, prevState) { - this._setIndex(this.props); - this._formatIndexDataResponse({ ...this.state, ...this.props }); - this._formatIndexPatternResponse({ ...this.state, ...this.props }); - if (prevState.importStage !== this.props.importStage) { - this.setState({ - importStage: this.props.importStage, - }); - } - } - - // Retain last index for UI purposes - _setIndex = ({ indexName }) => { - if (indexName && !this.state.indexName) { - this.setState({ indexName }); - } - }; - - // Format json responses - _formatIndexDataResponse = ({ indexDataResp, indexDataJson }) => { - if (indexDataResp && !indexDataJson) { - this.setState({ indexDataJson: JSON.stringify(indexDataResp, null, 2) }); - } - }; - - _formatIndexPatternResponse = ({ indexPatternResp, indexPatternJson }) => { - if (indexPatternResp && !indexPatternJson) { - this.setState({ indexPatternJson: JSON.stringify(indexPatternResp, null, 2) }); - } - }; - - render() { - const { complete } = this.props; - const { indexPatternJson, indexDataJson, indexName, importStage } = this.state; - const importMessage = complete ? importStage : `${importStage}: ${indexName}`; - - return ( - - {!complete ? : null} - -

- -

- - {importMessage &&

{importMessage}

} - - {complete ? ( - - {indexDataJson ? ( - - -

- -

- - - {indexDataJson} - - - - ) : null} - {indexPatternJson ? ( - - -

- -

- - - {indexPatternJson} - - - - ) : null} - -
- {i18n.translate('xpack.fileUpload.jsonImport.indexModsMsg', { - defaultMessage: 'Further index modifications can be made using\n', - })} - - {i18n.translate('xpack.fileUpload.jsonImport.indexMgmtLink', { - defaultMessage: 'Index Management', - })} - - . -
- - - ) : null} - - ); - } -} diff --git a/x-pack/plugins/file_upload/public/components/json_index_file_picker.js b/x-pack/plugins/file_upload/public/components/json_index_file_picker.js deleted file mode 100644 index 78bf7378578de..0000000000000 --- a/x-pack/plugins/file_upload/public/components/json_index_file_picker.js +++ /dev/null @@ -1,267 +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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { Fragment, Component } from 'react'; -import { EuiFilePicker, EuiFormRow, EuiProgress } from '@elastic/eui'; -import { FormattedMessage } from '@kbn/i18n/react'; -import { i18n } from '@kbn/i18n'; - -const MAX_FILE_SIZE = 52428800; -const ACCEPTABLE_FILETYPES = ['json', 'geojson']; -const acceptedFileTypeString = ACCEPTABLE_FILETYPES.map((type) => `.${type}`).join(','); -const acceptedFileTypeStringMessage = ACCEPTABLE_FILETYPES.map((type) => `.${type}`).join(', '); - -export class JsonIndexFilePicker extends Component { - state = { - fileUploadError: '', - percentageProcessed: 0, - featuresProcessed: 0, - fileParseActive: false, - currentFileTracker: null, - }; - - async componentDidMount() { - this._isMounted = true; - } - - componentWillUnmount() { - this._isMounted = false; - } - - isFileParseActive = () => this._isMounted && this.state.fileParseActive; - - _fileHandler = (fileList) => { - const fileArr = Array.from(fileList); - this.props.resetFileAndIndexSettings(); - this.setState({ - fileUploadError: '', - percentageProcessed: 0, - featuresProcessed: 0, - }); - if (fileArr.length === 0) { - // Remove - this.setState({ - fileParseActive: false, - }); - return; - } - const file = fileArr[0]; - - this.setState( - { - fileParseActive: true, - currentFileTracker: Symbol(), - }, - () => this._parseFile(file) - ); - }; - - _getFileNameAndCheckType({ name }) { - let fileNameOnly; - try { - if (!name) { - throw new Error( - i18n.translate('xpack.fileUpload.jsonIndexFilePicker.noFileNameError', { - defaultMessage: 'No file name provided', - }) - ); - } - - const splitNameArr = name.split('.'); - const fileType = splitNameArr.pop(); - if (!ACCEPTABLE_FILETYPES.includes(fileType)) { - //should only occur if browser does not accept the accept parameter - throw new Error( - i18n.translate('xpack.fileUpload.jsonIndexFilePicker.acceptableTypesError', { - defaultMessage: 'File is not one of acceptable types: {types}', - values: { - types: ACCEPTABLE_FILETYPES.join(', '), - }, - }) - ); - } - - fileNameOnly = splitNameArr[0]; - } catch (error) { - this.setState({ - fileUploadError: i18n.translate( - 'xpack.fileUpload.jsonIndexFilePicker.fileProcessingError', - { - defaultMessage: 'File processing error: {errorMessage}', - values: { - errorMessage: error.message, - }, - } - ), - }); - return; - } - return fileNameOnly.toLowerCase(); - } - - setFileProgress = ({ featuresProcessed, bytesProcessed, totalBytes }) => { - const percentageProcessed = parseInt((100 * bytesProcessed) / totalBytes); - if (this.isFileParseActive()) { - this.setState({ featuresProcessed, percentageProcessed }); - } - }; - - async _parseFile(file) { - const { currentFileTracker } = this.state; - const { setFileRef, setParsedFile, resetFileAndIndexSettings } = this.props; - - if (file.size > MAX_FILE_SIZE) { - this.setState({ - fileUploadError: i18n.translate('xpack.fileUpload.jsonIndexFilePicker.acceptableFileSize', { - defaultMessage: 'File size {fileSize} exceeds maximum file size of {maxFileSize}', - values: { - fileSize: bytesToSize(file.size), - maxFileSize: bytesToSize(MAX_FILE_SIZE), - }, - }), - }); - resetFileAndIndexSettings(); - return; - } - - const defaultIndexName = this._getFileNameAndCheckType(file); - if (!defaultIndexName) { - resetFileAndIndexSettings(); - return; - } - - const fileResult = await this.props.geojsonImporter - .readFile(file, this.setFileProgress, this.isFileParseActive) - .catch((err) => { - if (this._isMounted) { - this.setState({ - fileParseActive: false, - percentageProcessed: 0, - featuresProcessed: 0, - fileUploadError: ( - - ), - }); - resetFileAndIndexSettings(); - return; - } - }); - - if (!this._isMounted) { - return; - } - - // If another file is replacing this one, leave file parse active - this.setState({ - percentageProcessed: 0, - featuresProcessed: 0, - fileParseActive: currentFileTracker !== this.state.currentFileTracker, - }); - if (!fileResult) { - resetFileAndIndexSettings(); - return; - } - - if (fileResult.errors.length) { - this.setState({ - fileUploadError: ( - - ), - }); - } - setFileRef(file); - setParsedFile(fileResult, defaultIndexName); - } - - render() { - const { fileUploadError, percentageProcessed, featuresProcessed } = this.state; - - return ( - - {percentageProcessed ? ( - - ) : null} - - } - isInvalid={fileUploadError !== ''} - error={[fileUploadError]} - helpText={ - percentageProcessed ? ( - i18n.translate('xpack.fileUpload.jsonIndexFilePicker.parsingFile', { - defaultMessage: '{featuresProcessed} features parsed...', - values: { - featuresProcessed, - }, - }) - ) : ( - - {i18n.translate('xpack.fileUpload.jsonIndexFilePicker.formatsAccepted', { - defaultMessage: 'Formats accepted: {acceptedFileTypeStringMessage}', - values: { - acceptedFileTypeStringMessage, - }, - })}{' '} -
- -
- {i18n.translate('xpack.fileUpload.jsonIndexFilePicker.coordinateSystemAccepted', { - defaultMessage: 'Coordinates must be in EPSG:4326 coordinate reference system.', - })}{' '} - - ) - } - > - - } - onChange={this._fileHandler} - accept={acceptedFileTypeString} - /> - - - ); - } -} - -function bytesToSize(bytes) { - const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB']; - if (bytes === 0) return 'n/a'; - const i = parseInt(Math.floor(Math.log(bytes) / Math.log(1024)), 10); - if (i === 0) return `${bytes} ${sizes[i]})`; - return `${(bytes / 1024 ** i).toFixed(1)} ${sizes[i]}`; -} diff --git a/x-pack/plugins/file_upload/public/components/json_upload_and_parse.js b/x-pack/plugins/file_upload/public/components/json_upload_and_parse.js index d4f6858eb5995..ae9f5e9ac8154 100644 --- a/x-pack/plugins/file_upload/public/components/json_upload_and_parse.js +++ b/x-pack/plugins/file_upload/public/components/json_upload_and_parse.js @@ -7,65 +7,41 @@ import React, { Component, Fragment } from 'react'; import { i18n } from '@kbn/i18n'; -import { EuiForm } from '@elastic/eui'; +import { EuiForm, EuiProgress, EuiText } from '@elastic/eui'; import PropTypes from 'prop-types'; import { IndexSettings } from './index_settings'; -import { JsonIndexFilePicker } from './json_index_file_picker'; -import { JsonImportProgress } from './json_import_progress'; -import _ from 'lodash'; -import { GeoJsonImporter } from '../importer/geojson_importer'; -import { ES_FIELD_TYPES } from '../../../../../src/plugins/data/public'; import { getIndexPatternService } from '../kibana_services'; +import { GeoJsonFilePicker } from './geojson_file_picker'; +import { ImportCompleteView } from './import_complete_view'; +import { ES_FIELD_TYPES } from '../../../../../src/plugins/data/public'; -const INDEXING_STAGE = { - INDEXING_STARTED: i18n.translate('xpack.fileUpload.jsonUploadAndParse.dataIndexingStarted', { - defaultMessage: 'Data indexing started', - }), - WRITING_TO_INDEX: i18n.translate('xpack.fileUpload.jsonUploadAndParse.writingToIndex', { - defaultMessage: 'Writing to index', - }), - INDEXING_COMPLETE: i18n.translate('xpack.fileUpload.jsonUploadAndParse.indexingComplete', { - defaultMessage: 'Indexing complete', - }), - CREATING_INDEX_PATTERN: i18n.translate( - 'xpack.fileUpload.jsonUploadAndParse.creatingIndexPattern', - { defaultMessage: 'Creating index pattern' } - ), - INDEX_PATTERN_COMPLETE: i18n.translate( - 'xpack.fileUpload.jsonUploadAndParse.indexPatternComplete', - { defaultMessage: 'Index pattern complete' } - ), - INDEXING_ERROR: i18n.translate('xpack.fileUpload.jsonUploadAndParse.dataIndexingError', { - defaultMessage: 'Data indexing error', - }), - INDEX_PATTERN_ERROR: i18n.translate('xpack.fileUpload.jsonUploadAndParse.indexPatternError', { - defaultMessage: 'Index pattern error', - }), +const PHASE = { + CONFIGURE: 'CONFIGURE', + IMPORT: 'IMPORT', + COMPLETE: 'COMPLETE', }; -export class JsonUploadAndParse extends Component { - geojsonImporter = new GeoJsonImporter(); +function getWritingToIndexMsg(progress) { + return i18n.translate('xpack.fileUpload.jsonUploadAndParse.writingToIndex', { + defaultMessage: 'Writing to index: {progress}% complete', + values: { progress }, + }); +} +export class JsonUploadAndParse extends Component { state = { - // File state - fileRef: null, - parsedFile: null, - indexedFile: null, - // Index state indexTypes: [], selectedIndexType: '', indexName: '', - indexRequestInFlight: false, - indexPatternRequestInFlight: false, hasIndexErrors: false, isIndexReady: false, // Progress-tracking state - showImportProgress: false, - currentIndexingStage: INDEXING_STAGE.INDEXING_STARTED, - indexDataResp: '', - indexPatternResp: '', + importStatus: '', + phase: PHASE.CONFIGURE, + importResp: undefined, + indexPatternResp: undefined, }; componentDidMount() { @@ -74,102 +50,36 @@ export class JsonUploadAndParse extends Component { componentWillUnmount() { this._isMounted = false; - } - - _resetFileAndIndexSettings = () => { - if (this.props.onFileRemove && this.state.fileRef) { - this.props.onFileRemove(this.state.fileRef); - } - this.setState({ - indexTypes: [], - selectedIndexType: '', - indexName: '', - indexedFile: null, - parsedFile: null, - fileRef: null, - }); - }; - - componentDidUpdate() { - this._updateIndexType(); - this._setIndexReady({ ...this.state, ...this.props }); - this._indexData({ ...this.state, ...this.props }); - if (this.props.isIndexingTriggered && !this.state.showImportProgress && this._isMounted) { - this.setState({ showImportProgress: true }); + if (this._geojsonImporter) { + this._geojsonImporter.destroy(); + this._geojsonImporter = null; } } - _updateIndexType() { - let nextIndexTypes = []; - if (this.state.parsedFile) { - nextIndexTypes = - this.state.parsedFile.geometryTypes.includes('Point') || - this.state.parsedFile.geometryTypes.includes('MultiPoint') - ? [ES_FIELD_TYPES.GEO_POINT, ES_FIELD_TYPES.GEO_SHAPE] - : [ES_FIELD_TYPES.GEO_SHAPE]; - } - if (!_.isEqual(nextIndexTypes, this.state.indexTypes)) { - this.setState({ indexTypes: nextIndexTypes }); - } - - if (!this.state.selectedIndexType && nextIndexTypes.length) { - // auto select index type - this.setState({ selectedIndexType: nextIndexTypes[0] }); - } else if ( - this.state.selectedIndexType && - !nextIndexTypes.includes(this.state.selectedIndexType) - ) { - // unselected indexType if selected type is not longer an option - this.setState({ selectedIndexType: null }); + componentDidUpdate() { + this._setIndexReady(); + if (this.props.isIndexingTriggered && this.state.phase === PHASE.CONFIGURE) { + this._import(); } } - _setIndexReady = ({ - parsedFile, - selectedIndexType, - indexName, - hasIndexErrors, - indexRequestInFlight, - onIndexReady, - }) => { + _setIndexReady = () => { const isIndexReady = - !!parsedFile && - !!selectedIndexType && - !!indexName && - !hasIndexErrors && - !indexRequestInFlight; + this._geojsonImporter !== undefined && + !!this.state.selectedIndexType && + !!this.state.indexName && + !this.state.hasIndexErrors && + this.state.phase === PHASE.CONFIGURE; if (isIndexReady !== this.state.isIndexReady) { this.setState({ isIndexReady }); - if (onIndexReady) { - onIndexReady(isIndexReady); - } + this.props.onIndexReady(isIndexReady); } }; - _indexData = async ({ - indexedFile, - parsedFile, - indexRequestInFlight, - indexName, - selectedIndexType, - isIndexingTriggered, - isIndexReady, - onIndexingComplete, - onIndexingError, - }) => { - // Check index ready - const filesAreEqual = _.isEqual(indexedFile, parsedFile); - if (!isIndexingTriggered || filesAreEqual || !isIndexReady || indexRequestInFlight) { - return; - } - this.setState({ - indexRequestInFlight: true, - currentIndexingStage: INDEXING_STAGE.WRITING_TO_INDEX, - }); - - this.geojsonImporter.setDocs(parsedFile.parsedGeojson, selectedIndexType); - - // initialize import + _import = async () => { + // + // create index + // const settings = { number_of_shards: 1, }; @@ -181,8 +91,16 @@ export class JsonUploadAndParse extends Component { }, }; const ingestPipeline = {}; - const initializeImportResp = await this.geojsonImporter.initializeImport( - indexName, + this.setState({ + importStatus: i18n.translate('xpack.fileUpload.jsonUploadAndParse.dataIndexingStarted', { + defaultMessage: 'Creating index: {indexName}', + values: { indexName: this.state.indexName }, + }), + phase: PHASE.IMPORT, + }); + this._geojsonImporter.setGeoFieldType(this.state.selectedIndexType); + const initializeImportResp = await this._geojsonImporter.initializeImport( + this.state.indexName, settings, mappings, ingestPipeline @@ -192,131 +110,180 @@ export class JsonUploadAndParse extends Component { } if (initializeImportResp.index === undefined || initializeImportResp.id === undefined) { this.setState({ - indexRequestInFlight: false, - currentIndexingStage: INDEXING_STAGE.INDEXING_ERROR, + phase: PHASE.COMPLETE, }); - this._resetFileAndIndexSettings(); - onIndexingError(); + this.props.onIndexingError(); return; } + // // import file - const importResp = await this.geojsonImporter.import( + // + this.setState({ + importStatus: getWritingToIndexMsg(0), + }); + const importResp = await this._geojsonImporter.import( initializeImportResp.id, - indexName, + this.state.indexName, initializeImportResp.pipelineId, - () => {} + (progress) => { + if (this._isMounted) { + this.setState({ + importStatus: getWritingToIndexMsg(progress), + }); + } + } ); if (!this._isMounted) { return; } + if (!importResp.success) { this.setState({ - indexDataResp: importResp, - indexRequestInFlight: false, - currentIndexingStage: INDEXING_STAGE.INDEXING_ERROR, + importResp, + importStatus: i18n.translate('xpack.fileUpload.jsonUploadAndParse.dataIndexingError', { + defaultMessage: 'Data indexing error', + }), + phase: PHASE.COMPLETE, }); - this._resetFileAndIndexSettings(); - onIndexingError(); + this.props.onIndexingError(); return; } - this.setState({ - indexDataResp: importResp, - indexedFile: parsedFile, - currentIndexingStage: INDEXING_STAGE.INDEXING_COMPLETE, - }); + // // create index pattern + // this.setState({ - indexPatternRequestInFlight: true, - currentIndexingStage: INDEXING_STAGE.CREATING_INDEX_PATTERN, + importResp, + importStatus: i18n.translate('xpack.fileUpload.jsonUploadAndParse.creatingIndexPattern', { + defaultMessage: 'Creating index pattern: {indexName}', + values: { indexName: this.state.indexName }, + }), }); let indexPattern; try { indexPattern = await getIndexPatternService().createAndSave( { - title: indexName, + title: this.state.indexName, }, true ); } catch (error) { if (this._isMounted) { this.setState({ - indexPatternRequestInFlight: false, - currentIndexingStage: INDEXING_STAGE.INDEX_PATTERN_ERROR, + importStatus: i18n.translate('xpack.fileUpload.jsonUploadAndParse.indexPatternError', { + defaultMessage: 'Index pattern error', + }), + phase: PHASE.COMPLETE, }); - this._resetFileAndIndexSettings(); - onIndexingError(); + this.props.onIndexingError(); } return; } if (!this._isMounted) { return; } + + // + // Successful import + // this.setState({ indexPatternResp: { success: true, id: indexPattern.id, fields: indexPattern.fields, }, - indexPatternRequestInFlight: false, + phase: PHASE.COMPLETE, + importStatus: '', }); - this.setState({ - currentIndexingStage: INDEXING_STAGE.INDEX_PATTERN_COMPLETE, - }); - this._resetFileAndIndexSettings(); - onIndexingComplete({ + this.props.onIndexingComplete({ indexDataResp: importResp, indexPattern, }); }; - render() { - const { - currentIndexingStage, - indexDataResp, - indexPatternResp, - fileRef, + _onFileSelect = ({ features, hasPoints, hasShapes, importer, indexName, previewCoverage }) => { + this._geojsonImporter = importer; + + const geoFieldTypes = hasPoints + ? [ES_FIELD_TYPES.GEO_POINT, ES_FIELD_TYPES.GEO_SHAPE] + : [ES_FIELD_TYPES.GEO_SHAPE]; + + const newState = { + indexTypes: geoFieldTypes, + indexName, + }; + if (!this.state.selectedIndexType) { + // auto select index type + newState.selectedIndexType = + hasPoints && !hasShapes ? ES_FIELD_TYPES.GEO_POINT : ES_FIELD_TYPES.GEO_SHAPE; + } else if ( + this.state.selectedIndexType && + !geoFieldTypes.includes(this.state.selectedIndexType) + ) { + // unselected indexType if selected type is not longer an option + newState.selectedIndexType = ''; + } + this.setState(newState); + + this.props.onFileUpload( + { + type: 'FeatureCollection', + features, + }, indexName, - indexTypes, - showImportProgress, - } = this.state; + previewCoverage + ); + }; + + _onFileClear = () => { + if (this._geojsonImporter) { + this._geojsonImporter.destroy(); + this._geojsonImporter = undefined; + } + + this.props.onFileRemove(); + + this.setState({ + indexTypes: [], + selectedIndexType: '', + indexName: '', + }); + }; + + render() { + if (this.state.phase === PHASE.IMPORT) { + return ( + + + +

{this.state.importStatus}

+ + + ); + } + + if (this.state.phase === PHASE.COMPLETE) { + return ( + + ); + } return ( - {showImportProgress ? ( - - ) : ( - - this.setState({ fileRef })} - setParsedFile={(parsedFile, indexName) => { - this.setState({ parsedFile, indexName }); - this.props.onFileUpload(parsedFile.parsedGeojson, indexName); - }} - resetFileAndIndexSettings={this._resetFileAndIndexSettings} - geojsonImporter={this.geojsonImporter} - /> - this.setState({ indexName })} - indexTypes={indexTypes} - setSelectedIndexType={(selectedIndexType) => this.setState({ selectedIndexType })} - setHasIndexErrors={(hasIndexErrors) => this.setState({ hasIndexErrors })} - /> - - )} + + this.setState({ indexName })} + indexTypes={this.state.indexTypes} + selectedIndexType={this.state.selectedIndexType} + setSelectedIndexType={(selectedIndexType) => this.setState({ selectedIndexType })} + setHasIndexErrors={(hasIndexErrors) => this.setState({ hasIndexErrors })} + /> ); } diff --git a/x-pack/plugins/file_upload/public/get_max_bytes.ts b/x-pack/plugins/file_upload/public/get_max_bytes.ts new file mode 100644 index 0000000000000..2e002e65248c9 --- /dev/null +++ b/x-pack/plugins/file_upload/public/get_max_bytes.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +// @ts-ignore +import numeral from '@elastic/numeral'; +import { + MAX_FILE_SIZE, + MAX_FILE_SIZE_BYTES, + ABSOLUTE_MAX_FILE_SIZE_BYTES, + FILE_SIZE_DISPLAY_FORMAT, + UI_SETTING_MAX_FILE_SIZE, +} from '../common'; +import { getUiSettings } from './kibana_services'; + +export function getMaxBytes() { + const maxFileSize = getUiSettings().get(UI_SETTING_MAX_FILE_SIZE, MAX_FILE_SIZE); + // @ts-ignore + const maxBytes = numeral(maxFileSize.toUpperCase()).value(); + if (maxBytes < MAX_FILE_SIZE_BYTES) { + return MAX_FILE_SIZE_BYTES; + } + return maxBytes <= ABSOLUTE_MAX_FILE_SIZE_BYTES ? maxBytes : ABSOLUTE_MAX_FILE_SIZE_BYTES; +} + +export function getMaxBytesFormatted() { + return numeral(getMaxBytes()).format(FILE_SIZE_DISPLAY_FORMAT); +} diff --git a/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.test.js b/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.test.js index e348686dc060a..98f14f3e58166 100644 --- a/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.test.js +++ b/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.test.js @@ -5,7 +5,7 @@ * 2.0. */ -import { GeoJsonImporter } from './geojson_importer'; +import { GeoJsonImporter, toEsDocs } from './geojson_importer'; import { ES_FIELD_TYPES } from '../../../../../../src/plugins/data/public'; import '@loaders.gl/polyfills'; @@ -25,9 +25,7 @@ const FEATURE_COLLECTION = { ], }; -describe('readFile', () => { - const setFileProgress = jest.fn((a) => a); - +describe('previewFile', () => { const FILE_WITH_FEATURE_COLLECTION = new File( [JSON.stringify(FEATURE_COLLECTION)], 'testfile.json', @@ -39,38 +37,26 @@ describe('readFile', () => { jest.restoreAllMocks(); }); - test('should throw error if no file provided', async () => { - const importer = new GeoJsonImporter(); - await importer - .readFile(null, setFileProgress, () => { - return true; - }) - .catch((e) => { - expect(e.message).toMatch('Error, no file provided'); - }); - }); - - test('should abort if file parse is cancelled', async () => { - const importer = new GeoJsonImporter(); - - const results = await importer.readFile(FILE_WITH_FEATURE_COLLECTION, setFileProgress, () => { - return false; + test('should stop reading when importer is destroyed', async () => { + const importer = new GeoJsonImporter(FILE_WITH_FEATURE_COLLECTION); + importer.destroy(); + const results = await importer.previewFile(); + expect(results).toEqual({ + features: [], + previewCoverage: 0, + hasPoints: false, + hasShapes: false, }); - - expect(results).toBeNull(); }); test('should read features from feature collection', async () => { - const importer = new GeoJsonImporter(); - const results = await importer.readFile(FILE_WITH_FEATURE_COLLECTION, setFileProgress, () => { - return true; - }); - - expect(setFileProgress).toHaveBeenCalled(); + const importer = new GeoJsonImporter(FILE_WITH_FEATURE_COLLECTION); + const results = await importer.previewFile(); expect(results).toEqual({ - errors: [], - geometryTypes: ['Point'], - parsedGeojson: FEATURE_COLLECTION, + previewCoverage: 100, + hasPoints: true, + hasShapes: false, + features: FEATURE_COLLECTION.features, }); }); @@ -99,20 +85,14 @@ describe('readFile', () => { { type: 'text/json' } ); - const importer = new GeoJsonImporter(); - const results = await importer.readFile( - fileWithFeaturesWithoutGeometry, - setFileProgress, - () => { - return true; - } - ); + const importer = new GeoJsonImporter(fileWithFeaturesWithoutGeometry); + const results = await importer.previewFile(); - expect(setFileProgress).toHaveBeenCalled(); expect(results).toEqual({ - errors: ['2 features without geometry omitted'], - geometryTypes: ['Point'], - parsedGeojson: FEATURE_COLLECTION, + previewCoverage: 100, + hasPoints: true, + hasShapes: false, + features: FEATURE_COLLECTION.features, }); }); @@ -134,20 +114,18 @@ describe('readFile', () => { { type: 'text/json' } ); - const importer = new GeoJsonImporter(); - const results = await importer.readFile(fileWithUnwrapedFeature, setFileProgress, () => { - return true; - }); + const importer = new GeoJsonImporter(fileWithUnwrapedFeature); + const results = await importer.previewFile(); - expect(setFileProgress).toHaveBeenCalled(); expect(results).toEqual({ - errors: [], - geometryTypes: ['Point'], - parsedGeojson: FEATURE_COLLECTION, + previewCoverage: 100, + hasPoints: true, + hasShapes: false, + features: FEATURE_COLLECTION.features, }); }); - test('should throw if no features', async () => { + test('should return empty feature collection if no features', async () => { const fileWithNoFeatures = new File( [ JSON.stringify({ @@ -159,17 +137,18 @@ describe('readFile', () => { { type: 'text/json' } ); - const importer = new GeoJsonImporter(); - await importer - .readFile(fileWithNoFeatures, setFileProgress, () => { - return true; - }) - .catch((e) => { - expect(e.message).toMatch('Error, no features detected'); - }); + const importer = new GeoJsonImporter(fileWithNoFeatures); + const results = await importer.previewFile(); + + expect(results).toEqual({ + previewCoverage: 100, + hasPoints: false, + hasShapes: false, + features: [], + }); }); - test('should throw if no features with geometry', async () => { + test('should return empty feature collection if no features with geometry', async () => { const fileWithFeaturesWithNoGeometry = new File( [ JSON.stringify({ @@ -186,22 +165,22 @@ describe('readFile', () => { { type: 'text/json' } ); - const importer = new GeoJsonImporter(); - await importer - .readFile(fileWithFeaturesWithNoGeometry, setFileProgress, () => { - return true; - }) - .catch((e) => { - expect(e.message).toMatch('Error, no features detected'); - }); + const importer = new GeoJsonImporter(fileWithFeaturesWithNoGeometry); + const results = await importer.previewFile(); + + expect(results).toEqual({ + previewCoverage: 100, + hasPoints: false, + hasShapes: false, + features: [], + }); }); }); -describe('setDocs', () => { +describe('toEsDocs', () => { test('should convert features to geo_point ES documents', () => { - const importer = new GeoJsonImporter(); - importer.setDocs(FEATURE_COLLECTION, ES_FIELD_TYPES.GEO_POINT); - expect(importer.getDocs()).toEqual([ + const esDocs = toEsDocs(FEATURE_COLLECTION.features, ES_FIELD_TYPES.GEO_POINT); + expect(esDocs).toEqual([ { coordinates: [-112.0372, 46.608058], population: 200, @@ -210,9 +189,8 @@ describe('setDocs', () => { }); test('should convert features to geo_shape ES documents', () => { - const importer = new GeoJsonImporter(); - importer.setDocs(FEATURE_COLLECTION, ES_FIELD_TYPES.GEO_SHAPE); - expect(importer.getDocs()).toEqual([ + const esDocs = toEsDocs(FEATURE_COLLECTION.features, ES_FIELD_TYPES.GEO_SHAPE); + expect(esDocs).toEqual([ { coordinates: { type: 'point', diff --git a/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.ts b/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.ts index 189084e9180da..3294655916b5b 100644 --- a/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.ts +++ b/x-pack/plugins/file_upload/public/importer/geojson_importer/geojson_importer.ts @@ -7,7 +7,6 @@ import { Feature, - FeatureCollection, Point, MultiPoint, LineString, @@ -18,161 +17,274 @@ import { import { i18n } from '@kbn/i18n'; // @ts-expect-error import { JSONLoader, loadInBatches } from './loaders'; -import { CreateDocsResponse } from '../types'; -import { Importer } from '../importer'; +import { CreateDocsResponse, ImportResults } from '../types'; +import { callImportRoute, Importer, IMPORT_RETRIES } from '../importer'; import { ES_FIELD_TYPES } from '../../../../../../src/plugins/data/public'; // @ts-expect-error import { geoJsonCleanAndValidate } from './geojson_clean_and_validate'; +import { ImportFailure, ImportResponse, MB } from '../../../common'; + +const IMPORT_CHUNK_SIZE_MB = 10 * MB; +export const GEOJSON_FILE_TYPES = ['.json', '.geojson']; + +export interface GeoJsonPreview { + features: Feature[]; + hasPoints: boolean; + hasShapes: boolean; + previewCoverage: number; +} export class GeoJsonImporter extends Importer { - constructor() { + private _file: File; + private _isActive = true; + private _iterator?: Iterator; + private _hasNext = true; + private _features: Feature[] = []; + private _totalBytesProcessed = 0; + private _unimportedBytesProcessed = 0; + private _totalFeatures = 0; + private _geometryTypesMap = new Map(); + private _invalidFeatures: ImportFailure[] = []; + private _prevBatchLastFeature?: Feature; + private _geoFieldType: ES_FIELD_TYPES.GEO_POINT | ES_FIELD_TYPES.GEO_SHAPE = + ES_FIELD_TYPES.GEO_SHAPE; + + constructor(file: File) { super(); + + this._file = file; } - public read(data: ArrayBuffer): { success: boolean } { - throw new Error('read(data: ArrayBuffer) not supported, use readFile instead.'); + public destroy() { + this._isActive = false; } - protected _createDocs(text: string): CreateDocsResponse { - throw new Error('_createDocs not implemented.'); + public async previewFile(rowLimit?: number, sizeLimit?: number): Promise { + await this._readUntil(rowLimit, sizeLimit); + return { + features: [...this._features], + previewCoverage: this._hasNext + ? Math.round((this._unimportedBytesProcessed / this._file.size) * 100) + : 100, + hasPoints: this._geometryTypesMap.has('Point') || this._geometryTypesMap.has('MultiPoint'), + hasShapes: + this._geometryTypesMap.has('LineString') || + this._geometryTypesMap.has('MultiLineString') || + this._geometryTypesMap.has('Polygon') || + this._geometryTypesMap.has('MultiPolygon'), + }; } - public getDocs() { - return this._docArray; + public setGeoFieldType(geoFieldType: ES_FIELD_TYPES.GEO_POINT | ES_FIELD_TYPES.GEO_SHAPE) { + this._geoFieldType = geoFieldType; } - public setDocs( - featureCollection: FeatureCollection, - geoFieldType: ES_FIELD_TYPES.GEO_POINT | ES_FIELD_TYPES.GEO_SHAPE - ) { - this._docArray = []; - for (let i = 0; i < featureCollection.features.length; i++) { - const feature = featureCollection.features[i]; - const geometry = feature.geometry as - | Point - | MultiPoint - | LineString - | MultiLineString - | Polygon - | MultiPolygon; - const coordinates = - geoFieldType === ES_FIELD_TYPES.GEO_SHAPE - ? { - type: geometry.type.toLowerCase(), - coordinates: geometry.coordinates, - } - : geometry.coordinates; - const properties = feature.properties ? feature.properties : {}; - this._docArray.push({ - coordinates, - ...properties, - }); + public async import( + id: string, + index: string, + pipelineId: string, + setImportProgress: (progress: number) => void + ): Promise { + if (!id || !index) { + return { + success: false, + error: i18n.translate('xpack.fileUpload.import.noIdOrIndexSuppliedErrorMessage', { + defaultMessage: 'no ID or index supplied', + }), + }; } + + let success = true; + const failures: ImportFailure[] = [...this._invalidFeatures]; + let error; + + while ((this._features.length > 0 || this._hasNext) && this._isActive) { + await this._readUntil(undefined, IMPORT_CHUNK_SIZE_MB); + if (!this._isActive) { + return { + success: false, + failures, + docCount: this._totalFeatures, + }; + } + + let retries = IMPORT_RETRIES; + let resp: ImportResponse = { + success: false, + failures: [], + docCount: 0, + id: '', + index: '', + pipelineId: '', + }; + const data = toEsDocs(this._features, this._geoFieldType); + const progress = Math.round((this._totalBytesProcessed / this._file.size) * 100); + this._features = []; + this._unimportedBytesProcessed = 0; + + while (resp.success === false && retries > 0) { + try { + resp = await callImportRoute({ + id, + index, + data, + settings: {}, + mappings: {}, + ingestPipeline: { + id: pipelineId, + }, + }); + + if (retries < IMPORT_RETRIES) { + // eslint-disable-next-line no-console + console.log(`Retrying import ${IMPORT_RETRIES - retries}`); + } + + retries--; + } catch (err) { + resp.success = false; + resp.error = err; + retries = 0; + } + } + + failures.push(...resp.failures); + + if (!resp.success) { + success = false; + error = resp.error; + break; + } + + setImportProgress(progress); + } + + const result: ImportResults = { + success, + failures, + docCount: this._totalFeatures, + }; + + if (success) { + setImportProgress(100); + } else { + result.error = error; + } + + return result; } - public async readFile( - file: File, - setFileProgress: ({ - featuresProcessed, - bytesProcessed, - totalBytes, - }: { - featuresProcessed: number; - bytesProcessed: number; - totalBytes: number; - }) => void, - isFileParseActive: () => boolean - ): Promise<{ - errors: string[]; - geometryTypes: string[]; - parsedGeojson: FeatureCollection; - } | null> { - if (!file) { - throw new Error( - i18n.translate('xpack.fileUpload.fileParser.noFileProvided', { - defaultMessage: 'Error, no file provided', - }) - ); + private async _readUntil(rowLimit?: number, sizeLimit?: number) { + while ( + this._isActive && + this._hasNext && + (rowLimit === undefined || this._features.length < rowLimit) && + (sizeLimit === undefined || this._unimportedBytesProcessed < sizeLimit) + ) { + await this._next(); } + } - return new Promise(async (resolve, reject) => { - const batches = await loadInBatches(file, JSONLoader, { + private async _next() { + if (this._iterator === undefined) { + this._iterator = await loadInBatches(this._file, JSONLoader, { json: { jsonpaths: ['$.features'], _rootObjectBatches: true, }, }); + } - const rawFeatures: unknown[] = []; - for await (const batch of batches) { - if (!isFileParseActive()) { - break; - } + if (!this._isActive || !this._iterator) { + return; + } - if (batch.batchType === 'root-object-batch-complete') { - // Handle single feature geoJson - if (rawFeatures.length === 0) { - rawFeatures.push(batch.container); - } - } else { - rawFeatures.push(...batch.data); - } + const { value: batch, done } = await this._iterator.next(); - setFileProgress({ - featuresProcessed: rawFeatures.length, - bytesProcessed: batch.bytesUsed, - totalBytes: file.size, - }); - } + if (!this._isActive || done) { + this._hasNext = false; + return; + } + + if ('bytesUsed' in batch) { + const bytesRead = batch.bytesUsed - this._totalBytesProcessed; + this._unimportedBytesProcessed += bytesRead; + this._totalBytesProcessed = batch.bytesUsed; + } - if (!isFileParseActive()) { - resolve(null); - return; + const rawFeatures: unknown[] = this._prevBatchLastFeature ? [this._prevBatchLastFeature] : []; + this._prevBatchLastFeature = undefined; + const isLastBatch = batch.batchType === 'root-object-batch-complete'; + if (isLastBatch) { + // Handle single feature geoJson + if (this._totalFeatures === 0) { + rawFeatures.push(batch.container); } + } else { + rawFeatures.push(...batch.data); + } - if (rawFeatures.length === 0) { - reject( - new Error( - i18n.translate('xpack.fileUpload.fileParser.noFeaturesDetected', { - defaultMessage: 'Error, no features detected', - }) - ) - ); - return; + for (let i = 0; i < rawFeatures.length; i++) { + const rawFeature = rawFeatures[i] as Feature; + if (!isLastBatch && i === rawFeatures.length - 1) { + // Do not process last feature until next batch is read, features on batch boundary may be incomplete. + this._prevBatchLastFeature = rawFeature; + continue; } - const features: Feature[] = []; - const geometryTypesMap = new Map(); - let invalidCount = 0; - for (let i = 0; i < rawFeatures.length; i++) { - const rawFeature = rawFeatures[i] as Feature; - if (!rawFeature.geometry || !rawFeature.geometry.type) { - invalidCount++; - } else { - if (!geometryTypesMap.has(rawFeature.geometry.type)) { - geometryTypesMap.set(rawFeature.geometry.type, true); - } - features.push(geoJsonCleanAndValidate(rawFeature)); + this._totalFeatures++; + if (!rawFeature.geometry || !rawFeature.geometry.type) { + this._invalidFeatures.push({ + item: this._totalFeatures, + reason: i18n.translate('xpack.fileUpload.geojsonImporter.noGeometry', { + defaultMessage: 'Feature does not contain required field "geometry"', + }), + doc: rawFeature, + }); + } else { + if (!this._geometryTypesMap.has(rawFeature.geometry.type)) { + this._geometryTypesMap.set(rawFeature.geometry.type, true); } + this._features.push(geoJsonCleanAndValidate(rawFeature)); } + } + } - const errors: string[] = []; - if (invalidCount > 0) { - errors.push( - i18n.translate('xpack.fileUpload.fileParser.featuresOmitted', { - defaultMessage: '{invalidCount} features without geometry omitted', - values: { invalidCount }, - }) - ); - } - resolve({ - errors, - geometryTypes: Array.from(geometryTypesMap.keys()), - parsedGeojson: { - type: 'FeatureCollection', - features, - }, - }); + public read(data: ArrayBuffer): { success: boolean } { + throw new Error('read(data: ArrayBuffer) not supported, use readFile instead.'); + } + + protected _createDocs(text: string): CreateDocsResponse { + throw new Error('_createDocs not implemented.'); + } +} + +export function toEsDocs( + features: Feature[], + geoFieldType: ES_FIELD_TYPES.GEO_POINT | ES_FIELD_TYPES.GEO_SHAPE +) { + const esDocs = []; + for (let i = 0; i < features.length; i++) { + const feature = features[i]; + const geometry = feature.geometry as + | Point + | MultiPoint + | LineString + | MultiLineString + | Polygon + | MultiPolygon; + const coordinates = + geoFieldType === ES_FIELD_TYPES.GEO_SHAPE + ? { + type: geometry.type.toLowerCase(), + coordinates: geometry.coordinates, + } + : geometry.coordinates; + const properties = feature.properties ? feature.properties : {}; + esDocs.push({ + coordinates, + ...properties, }); } + return esDocs; } diff --git a/x-pack/plugins/file_upload/public/importer/geojson_importer/index.ts b/x-pack/plugins/file_upload/public/importer/geojson_importer/index.ts index 9ffb84e603161..b5f6845e28324 100644 --- a/x-pack/plugins/file_upload/public/importer/geojson_importer/index.ts +++ b/x-pack/plugins/file_upload/public/importer/geojson_importer/index.ts @@ -5,4 +5,4 @@ * 2.0. */ -export { GeoJsonImporter } from './geojson_importer'; +export { GeoJsonImporter, GeoJsonPreview, GEOJSON_FILE_TYPES } from './geojson_importer'; diff --git a/x-pack/plugins/file_upload/public/importer/importer.ts b/x-pack/plugins/file_upload/public/importer/importer.ts index 8bdb465bd69cf..2689f3badc397 100644 --- a/x-pack/plugins/file_upload/public/importer/importer.ts +++ b/x-pack/plugins/file_upload/public/importer/importer.ts @@ -22,7 +22,7 @@ import { CreateDocsResponse, IImporter, ImportResults } from './types'; const CHUNK_SIZE = 5000; const MAX_CHUNK_CHAR_COUNT = 1000000; -const IMPORT_RETRIES = 5; +export const IMPORT_RETRIES = 5; const STRING_CHUNKS_MB = 100; export abstract class Importer implements IImporter { @@ -232,7 +232,7 @@ function createDocumentChunks(docArray: ImportDoc[]) { return chunks; } -function callImportRoute({ +export function callImportRoute({ id, index, data, diff --git a/x-pack/plugins/file_upload/public/importer/index.ts b/x-pack/plugins/file_upload/public/importer/index.ts index face822f91efb..22465ae2df8a7 100644 --- a/x-pack/plugins/file_upload/public/importer/index.ts +++ b/x-pack/plugins/file_upload/public/importer/index.ts @@ -6,4 +6,5 @@ */ export { importerFactory } from './importer_factory'; +export { validateFile } from './validate_file'; export * from './types'; diff --git a/x-pack/plugins/file_upload/public/importer/validate_file.ts b/x-pack/plugins/file_upload/public/importer/validate_file.ts new file mode 100644 index 0000000000000..4c7fe704d8afa --- /dev/null +++ b/x-pack/plugins/file_upload/public/importer/validate_file.ts @@ -0,0 +1,52 @@ +/* + * 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 { i18n } from '@kbn/i18n'; +import { getMaxBytes, getMaxBytesFormatted } from '../get_max_bytes'; + +export function validateFile(file: File, types: string[]) { + if (file.size > getMaxBytes()) { + throw new Error( + i18n.translate('xpack.fileUpload.fileSizeError', { + defaultMessage: 'File size {fileSize} exceeds maximum file size of {maxFileSize}', + values: { + fileSize: bytesToSize(file.size), + maxFileSize: getMaxBytesFormatted(), + }, + }) + ); + } + + if (!file.name) { + throw new Error( + i18n.translate('xpack.fileUpload.noFileNameError', { + defaultMessage: 'File name not provided', + }) + ); + } + + const nameSplit = file.name.split('.'); + const fileType = nameSplit.pop(); + if (!types.includes(`.${fileType}`)) { + throw new Error( + i18n.translate('xpack.fileUpload.fileTypeError', { + defaultMessage: 'File is not one of acceptable types: {types}', + values: { + types: types.join(', '), + }, + }) + ); + } +} + +function bytesToSize(bytes: number) { + if (bytes === 0) return 'n/a'; + const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB']; + const i = Math.round(Math.floor(Math.log(bytes) / Math.log(1024))); + if (i === 0) return `${bytes} ${sizes[i]})`; + return `${(bytes / 1024 ** i).toFixed(1)} ${sizes[i]}`; +} diff --git a/x-pack/plugins/file_upload/public/kibana_services.ts b/x-pack/plugins/file_upload/public/kibana_services.ts index c007c5c2273a8..a604136ca34e4 100644 --- a/x-pack/plugins/file_upload/public/kibana_services.ts +++ b/x-pack/plugins/file_upload/public/kibana_services.ts @@ -18,3 +18,4 @@ export function setStartServices(core: CoreStart, plugins: FileUploadStartDepend export const getIndexPatternService = () => pluginsStart.data.indexPatterns; export const getHttp = () => coreStart.http; export const getSavedObjectsClient = () => coreStart.savedObjects.client; +export const getUiSettings = () => coreStart.uiSettings; diff --git a/x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts b/x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts index 9cfc0896f5c2d..a61faa5bef0c4 100644 --- a/x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts +++ b/x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts @@ -12,7 +12,7 @@ import { IImporter, ImportFactoryOptions, ImportResults } from '../importer'; export interface FileUploadComponentProps { isIndexingTriggered: boolean; - onFileUpload: (geojsonFile: FeatureCollection, name: string) => void; + onFileUpload: (geojsonFile: FeatureCollection, name: string, previewCoverage: number) => void; onFileRemove: () => void; onIndexReady: (indexReady: boolean) => void; onIndexingComplete: (results: { diff --git a/x-pack/plugins/file_upload/public/plugin.ts b/x-pack/plugins/file_upload/public/plugin.ts index 5d3918193d48a..af3dd65b788a7 100644 --- a/x-pack/plugins/file_upload/public/plugin.ts +++ b/x-pack/plugins/file_upload/public/plugin.ts @@ -9,6 +9,7 @@ import { CoreStart, Plugin } from '../../../../src/core/public'; import { FileUploadStartApi, getFileUploadComponent, importerFactory } from './api'; import { setStartServices } from './kibana_services'; import { DataPublicPluginStart } from '../../../../src/plugins/data/public'; +import { getMaxBytes, getMaxBytesFormatted } from './get_max_bytes'; // eslint-disable-next-line @typescript-eslint/no-empty-interface export interface FileUploadSetupDependencies {} @@ -34,6 +35,8 @@ export class FileUploadPlugin return { getFileUploadComponent, importerFactory, + getMaxBytes, + getMaxBytesFormatted, }; } } diff --git a/x-pack/plugins/file_upload/server/plugin.ts b/x-pack/plugins/file_upload/server/plugin.ts index 74a18633d8a26..94b4f0368d562 100644 --- a/x-pack/plugins/file_upload/server/plugin.ts +++ b/x-pack/plugins/file_upload/server/plugin.ts @@ -5,10 +5,13 @@ * 2.0. */ +import { i18n } from '@kbn/i18n'; import { CoreSetup, CoreStart, Plugin } from 'src/core/server'; +import { schema } from '@kbn/config-schema'; import { fileUploadRoutes } from './routes'; import { initFileUploadTelemetry } from './telemetry'; import { UsageCollectionSetup } from '../../../../src/plugins/usage_collection/server'; +import { UI_SETTING_MAX_FILE_SIZE, MAX_FILE_SIZE } from '../common'; interface SetupDeps { usageCollection: UsageCollectionSetup; @@ -18,6 +21,26 @@ export class FileUploadPlugin implements Plugin { async setup(coreSetup: CoreSetup, plugins: SetupDeps) { fileUploadRoutes(coreSetup.http.createRouter()); + coreSetup.uiSettings.register({ + [UI_SETTING_MAX_FILE_SIZE]: { + name: i18n.translate('xpack.fileUpload.maxFileSizeUiSetting.name', { + defaultMessage: 'Maximum file upload size', + }), + value: MAX_FILE_SIZE, + description: i18n.translate('xpack.fileUpload.maxFileSizeUiSetting.description', { + defaultMessage: + 'Sets the file size limit when importing files. The highest supported value for this setting is 1GB.', + }), + schema: schema.string(), + validation: { + regexString: '\\d+[mMgG][bB]', + message: i18n.translate('xpack.fileUpload.maxFileSizeUiSetting.error', { + defaultMessage: 'Should be a valid data size. e.g. 200MB, 1GB', + }), + }, + }, + }); + initFileUploadTelemetry(coreSetup, plugins.usageCollection); } diff --git a/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts index c825f148cd0ce..7b757aa9cf10b 100644 --- a/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts @@ -174,6 +174,8 @@ export type InlineFieldDescriptor = { export type GeojsonFileSourceDescriptor = { __fields?: InlineFieldDescriptor[]; __featureCollection: FeatureCollection; + areResultsTrimmed: boolean; + tooltipContent: string | null; name: string; type: string; }; diff --git a/x-pack/plugins/maps/public/classes/layers/file_upload_wizard/wizard.tsx b/x-pack/plugins/maps/public/classes/layers/file_upload_wizard/wizard.tsx index 138ed7a8cd0b1..30e3317a3a3cf 100644 --- a/x-pack/plugins/maps/public/classes/layers/file_upload_wizard/wizard.tsx +++ b/x-pack/plugins/maps/public/classes/layers/file_upload_wizard/wizard.tsx @@ -5,6 +5,7 @@ * 2.0. */ +import { i18n } from '@kbn/i18n'; import React, { Component } from 'react'; import { FeatureCollection } from 'geojson'; import { EuiPanel } from '@elastic/eui'; @@ -70,7 +71,7 @@ export class ClientFileCreateSourceEditor extends Component { + _onFileUpload = (geojsonFile: FeatureCollection, name: string, previewCoverage: number) => { if (!this._isMounted) { return; } @@ -80,8 +81,19 @@ export class ClientFileCreateSourceEditor extends Component = ({ coreStart, deps, appMountParams }) => { embeddable: deps.embeddable, maps: deps.maps, triggersActionsUi: deps.triggersActionsUi, + fileUpload: deps.fileUpload, ...coreStart, }; diff --git a/x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts b/x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts index 99d4b77547d9d..3c86bb520600f 100644 --- a/x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts +++ b/x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts @@ -18,6 +18,7 @@ import { MlServicesContext } from '../../app'; import { IStorageWrapper } from '../../../../../../../src/plugins/kibana_utils/public'; import type { EmbeddableStart } from '../../../../../../../src/plugins/embeddable/public'; import type { MapsStartApi } from '../../../../../maps/public'; +import type { FileUploadPluginStart } from '../../../../../file_upload/public'; import type { LensPublicStart } from '../../../../../lens/public'; import { TriggersAndActionsUIPublicPluginStart } from '../../../../../triggers_actions_ui/public'; @@ -30,6 +31,7 @@ interface StartPlugins { maps?: MapsStartApi; lens?: LensPublicStart; triggersActionsUi?: TriggersAndActionsUIPublicPluginStart; + fileUpload?: FileUploadPluginStart; } export type StartServices = CoreStart & StartPlugins & { diff --git a/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx b/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx index 79d17a7846b8c..fc03ff475e05a 100644 --- a/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx +++ b/x-pack/plugins/ml/public/application/datavisualizer/datavisualizer_selector.tsx @@ -25,9 +25,7 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n/react'; import { isFullLicense } from '../license'; import { useTimefilter, useMlKibana, useNavigateToPath } from '../contexts/kibana'; - import { NavigationMenu } from '../components/navigation_menu'; -import { getMaxBytesFormatted } from './file_based/components/utils'; import { HelpMenu } from '../components/help_menu'; function startTrialDescription() { @@ -58,8 +56,10 @@ export const DatavisualizerSelector: FC = () => { licenseManagement, http: { basePath }, docLinks, + fileUpload, }, } = useMlKibana(); + const helpLink = docLinks.links.ml.guide; const navigateToPath = useNavigateToPath(); @@ -68,7 +68,12 @@ export const DatavisualizerSelector: FC = () => { licenseManagement.enabled === true && isFullLicense() === false; - const maxFileSize = getMaxBytesFormatted(); + if (fileUpload === undefined) { + // eslint-disable-next-line no-console + console.error('File upload plugin not available'); + return null; + } + const maxFileSize = fileUpload.getMaxBytesFormatted(); return ( diff --git a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/about_panel/welcome_content.tsx b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/about_panel/welcome_content.tsx index f20319e606681..2c441e42dea2f 100644 --- a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/about_panel/welcome_content.tsx +++ b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/about_panel/welcome_content.tsx @@ -20,7 +20,8 @@ import { } from '@elastic/eui'; import { ExperimentalBadge } from '../experimental_badge'; -import { getMaxBytesFormatted } from '../utils'; + +import { useMlKibana } from '../../../../contexts/kibana'; export const WelcomeContent: FC = () => { const toolTipContent = i18n.translate( @@ -30,7 +31,16 @@ export const WelcomeContent: FC = () => { } ); - const maxFileSize = getMaxBytesFormatted(); + const { + services: { fileUpload }, + } = useMlKibana(); + + if (fileUpload === undefined) { + // eslint-disable-next-line no-console + console.error('File upload plugin not available'); + return null; + } + const maxFileSize = fileUpload.getMaxBytesFormatted(); return ( diff --git a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/file_datavisualizer_view/file_datavisualizer_view.js b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/file_datavisualizer_view/file_datavisualizer_view.js index 8b683a154519e..90c2b2bf18639 100644 --- a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/file_datavisualizer_view/file_datavisualizer_view.js +++ b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/file_datavisualizer_view/file_datavisualizer_view.js @@ -22,12 +22,12 @@ import { ExplanationFlyout } from '../explanation_flyout'; import { ImportView } from '../import_view'; import { DEFAULT_LINES_TO_SAMPLE, - getMaxBytes, readFile, createUrlOverrides, processResults, hasImportPermission, } from '../utils'; +import { getFileUpload } from '../../../../util/dependency_cache'; import { MODE } from './constants'; @@ -60,7 +60,7 @@ export class FileDataVisualizerView extends Component { this.originalSettings = { linesToSample: DEFAULT_LINES_TO_SAMPLE, }; - this.maxFileUploadBytes = getMaxBytes(); + this.maxFileUploadBytes = getFileUpload().getMaxBytes(); } async componentDidMount() { diff --git a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/index.ts b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/index.ts index 41ea5582a7de5..209f2ef5ad174 100644 --- a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/index.ts +++ b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/index.ts @@ -10,7 +10,5 @@ export { hasImportPermission, processResults, readFile, - getMaxBytes, - getMaxBytesFormatted, DEFAULT_LINES_TO_SAMPLE, } from './utils'; diff --git a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/utils.ts b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/utils.ts index 2c1b02b53354a..ebde771603fcf 100644 --- a/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/utils.ts +++ b/x-pack/plugins/ml/public/application/datavisualizer/file_based/components/utils/utils.ts @@ -6,19 +6,9 @@ */ import { isEqual } from 'lodash'; -// @ts-ignore -import numeral from '@elastic/numeral'; import { ml } from '../../../../services/ml_api_service'; import { AnalysisResult, InputOverrides } from '../../../../../../common/types/file_datavisualizer'; -import { - MB, - MAX_FILE_SIZE, - MAX_FILE_SIZE_BYTES, - ABSOLUTE_MAX_FILE_SIZE_BYTES, - FILE_SIZE_DISPLAY_FORMAT, -} from '../../../../../../../file_upload/public'; -import { getUiSettings } from '../../../../util/dependency_cache'; -import { FILE_DATA_VISUALIZER_MAX_FILE_SIZE } from '../../../../../../common/constants/settings'; +import { MB } from '../../../../../../../file_upload/public'; export const DEFAULT_LINES_TO_SAMPLE = 1000; const UPLOAD_SIZE_MB = 5; @@ -66,20 +56,6 @@ export function readFile(file: File) { }); } -export function getMaxBytes() { - const maxFileSize = getUiSettings().get(FILE_DATA_VISUALIZER_MAX_FILE_SIZE, MAX_FILE_SIZE); - // @ts-ignore - const maxBytes = numeral(maxFileSize.toUpperCase()).value(); - if (maxBytes < MAX_FILE_SIZE_BYTES) { - return MAX_FILE_SIZE_BYTES; - } - return maxBytes <= ABSOLUTE_MAX_FILE_SIZE_BYTES ? maxBytes : ABSOLUTE_MAX_FILE_SIZE_BYTES; -} - -export function getMaxBytesFormatted() { - return numeral(getMaxBytes()).format(FILE_SIZE_DISPLAY_FORMAT); -} - export function createUrlOverrides(overrides: InputOverrides, originalSettings: InputOverrides) { const formattedOverrides: InputOverrides = {}; for (const o in overrideDefaults) { diff --git a/x-pack/plugins/ml/server/lib/register_settings.ts b/x-pack/plugins/ml/server/lib/register_settings.ts index 5f9107bd29815..8f279114344e4 100644 --- a/x-pack/plugins/ml/server/lib/register_settings.ts +++ b/x-pack/plugins/ml/server/lib/register_settings.ts @@ -9,34 +9,14 @@ import { CoreSetup } from 'kibana/server'; import { i18n } from '@kbn/i18n'; import { schema } from '@kbn/config-schema'; import { - FILE_DATA_VISUALIZER_MAX_FILE_SIZE, ANOMALY_DETECTION_DEFAULT_TIME_RANGE, ANOMALY_DETECTION_ENABLE_TIME_RANGE, DEFAULT_AD_RESULTS_TIME_FILTER, DEFAULT_ENABLE_AD_RESULTS_TIME_FILTER, } from '../../common/constants/settings'; -import { MAX_FILE_SIZE } from '../../../file_upload/common'; export function registerKibanaSettings(coreSetup: CoreSetup) { coreSetup.uiSettings.register({ - [FILE_DATA_VISUALIZER_MAX_FILE_SIZE]: { - name: i18n.translate('xpack.ml.maxFileSizeSettingsName', { - defaultMessage: 'File Data Visualizer maximum file upload size', - }), - value: MAX_FILE_SIZE, - description: i18n.translate('xpack.ml.maxFileSizeSettingsDescription', { - defaultMessage: - 'Sets the file size limit when importing data in the File Data Visualizer. The highest supported value for this setting is 1GB.', - }), - category: ['machineLearning'], - schema: schema.string(), - validation: { - regexString: '\\d+[mMgG][bB]', - message: i18n.translate('xpack.ml.maxFileSizeSettingsError', { - defaultMessage: 'Should be a valid data size. e.g. 200MB, 1GB', - }), - }, - }, [ANOMALY_DETECTION_ENABLE_TIME_RANGE]: { name: i18n.translate('xpack.ml.advancedSettings.enableAnomalyDetectionDefaultTimeRangeName', { defaultMessage: 'Enable time filter defaults for anomaly detection results', diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index dd628134c521e..6e1f96e80b573 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -7424,8 +7424,6 @@ "xpack.features.savedObjectsManagementFeatureName": "保存されたオブジェクトの管理", "xpack.features.visualizeFeatureName": "可視化", "xpack.fileUpload.enterIndexName": "インデックス名を入力", - "xpack.fileUpload.fileParser.noFeaturesDetected": "エラー、機能が検出されませんでした", - "xpack.fileUpload.fileParser.noFileProvided": "エラー、ファイルが提供されていません", "xpack.fileUpload.httpService.fetchError": "フェッチ実行エラー：{error}", "xpack.fileUpload.httpService.noUrl": "URLが指定されていません", "xpack.fileUpload.indexNameReqField": "インデックス名、必須フィールド", @@ -7441,29 +7439,11 @@ "xpack.fileUpload.indexSettings.indexNameContainsIllegalCharactersErrorMessage": "インデックス名に許可されていない文字が含まれています", "xpack.fileUpload.indexSettings.indexNameGuidelines": "インデックス名ガイドライン", "xpack.fileUpload.jsonImport.indexingResponse": "インデックス応答", - "xpack.fileUpload.jsonImport.indexingStatus": "インデックスステータス", "xpack.fileUpload.jsonImport.indexMgmtLink": "インデックス管理", "xpack.fileUpload.jsonImport.indexModsMsg": "次を使用すると、その他のインデックス修正を行うことができます。\n", "xpack.fileUpload.jsonImport.indexPatternResponse": "インデックスパターン応答", - "xpack.fileUpload.jsonIndexFilePicker.acceptableFileSize": "ファイルサイズ {fileSize} は最大ファイルサイズの{maxFileSize} を超えています", - "xpack.fileUpload.jsonIndexFilePicker.acceptableTypesError": "ファイルは使用可能なタイプのいずれかではありません。{types}", - "xpack.fileUpload.jsonIndexFilePicker.coordinateSystemAccepted": "座標は EPSG:4326 座標参照系でなければなりません。", - "xpack.fileUpload.jsonIndexFilePicker.fileParseError": "ファイル解析エラーが検出されました：{error}", - "xpack.fileUpload.jsonIndexFilePicker.filePicker": "ファイルをアップロード", - "xpack.fileUpload.jsonIndexFilePicker.filePickerLabel": "アップロードするファイルを選択", - "xpack.fileUpload.jsonIndexFilePicker.fileProcessingError": "ファイル処理エラー: {errorMessage}", - "xpack.fileUpload.jsonIndexFilePicker.formatsAccepted": "許可されているフォーマット：{acceptedFileTypeStringMessage}", - "xpack.fileUpload.jsonIndexFilePicker.maxSize": "最大サイズ：{maxFileSize}", - "xpack.fileUpload.jsonIndexFilePicker.noFileNameError": "ファイル名が指定されていません", - "xpack.fileUpload.jsonIndexFilePicker.parsingFile": "{featuresProcessed} 機能が解析されました...", - "xpack.fileUpload.jsonIndexFilePicker.unableParseFile": "ファイルをパースできません。{error}", - "xpack.fileUpload.jsonUploadAndParse.creatingIndexPattern": "インデックスパターンを作成中です", "xpack.fileUpload.jsonUploadAndParse.dataIndexingError": "データインデックスエラー", - "xpack.fileUpload.jsonUploadAndParse.dataIndexingStarted": "データインデックスが開始しました", - "xpack.fileUpload.jsonUploadAndParse.indexingComplete": "インデックス完了", - "xpack.fileUpload.jsonUploadAndParse.indexPatternComplete": "インデックスパターンの完了", "xpack.fileUpload.jsonUploadAndParse.indexPatternError": "インデックスパターンエラー", - "xpack.fileUpload.jsonUploadAndParse.writingToIndex": "インデックスに書き込み中", "xpack.fleet.agentBulkActions.agentsSelected": "{count, plural, other {#個のエージェント}}が選択されました", "xpack.fleet.agentBulkActions.clearSelection": "選択した項目をクリア", "xpack.fleet.agentBulkActions.reassignPolicy": "新しいポリシーに割り当てる", @@ -13417,9 +13397,6 @@ "xpack.ml.management.syncSavedObjectsFlyout.sync.error": "一部のジョブを同期できません。", "xpack.ml.management.syncSavedObjectsFlyout.sync.success": "{successCount} {successCount, plural, other {件のジョブ}}が同期されました", "xpack.ml.management.syncSavedObjectsFlyout.syncButton": "同期", - "xpack.ml.maxFileSizeSettingsDescription": "ファイルデータビジュアライザーでデータをインポートするときのファイルサイズ上限を設定します。この設定でサポートされている最大値は1 GBです。", - "xpack.ml.maxFileSizeSettingsError": "200 MB、1 GBなどの有効なデータサイズにしてください。", - "xpack.ml.maxFileSizeSettingsName": "ファイルデータビジュアライザーの最大ファイルアップロードサイズ", "xpack.ml.models.jobService.allOtherRequestsCancelledDescription": " 他のすべてのリクエストはキャンセルされました。", "xpack.ml.models.jobService.categorization.messages.failureToGetTokens": "フィールド値の例のサンプルをトークン化することができませんでした。{message}", "xpack.ml.models.jobService.categorization.messages.insufficientPrivileges": "権限が不十分なため、フィールド値の例のトークン化を実行できませんでした。そのため、フィールド値を確認し、カテゴリー分けジョブでの使用が適当かを確認することができません。", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index c733f214be554..b5a4b8a708513 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -7443,8 +7443,6 @@ "xpack.features.savedObjectsManagementFeatureName": "已保存对象管理", "xpack.features.visualizeFeatureName": "Visualize", "xpack.fileUpload.enterIndexName": "输入索引名称", - "xpack.fileUpload.fileParser.noFeaturesDetected": "错误，未检测到特征", - "xpack.fileUpload.fileParser.noFileProvided": "错误，未提供任何文件", "xpack.fileUpload.httpService.fetchError": "执行提取时出错：{error}", "xpack.fileUpload.httpService.noUrl": "未提供 URL", "xpack.fileUpload.indexNameReqField": "索引名称，必填字段", @@ -7460,29 +7458,11 @@ "xpack.fileUpload.indexSettings.indexNameContainsIllegalCharactersErrorMessage": "索引名称包含非法字符。", "xpack.fileUpload.indexSettings.indexNameGuidelines": "索引名称指引", "xpack.fileUpload.jsonImport.indexingResponse": "索引响应", - "xpack.fileUpload.jsonImport.indexingStatus": "索引状态", "xpack.fileUpload.jsonImport.indexMgmtLink": "索引管理", "xpack.fileUpload.jsonImport.indexModsMsg": "要进一步做索引修改，可以使用\n", "xpack.fileUpload.jsonImport.indexPatternResponse": "索引模式响应", - "xpack.fileUpload.jsonIndexFilePicker.acceptableFileSize": "文件大小 {fileSize} 超过最大文件大小 {maxFileSize}", - "xpack.fileUpload.jsonIndexFilePicker.acceptableTypesError": "文件不是可接受类型之一：{types}", - "xpack.fileUpload.jsonIndexFilePicker.coordinateSystemAccepted": "坐标必须在 EPSG:4326 坐标参考系中。", - "xpack.fileUpload.jsonIndexFilePicker.fileParseError": "检测到文件解析错误：{error}", - "xpack.fileUpload.jsonIndexFilePicker.filePicker": "上传文件", - "xpack.fileUpload.jsonIndexFilePicker.filePickerLabel": "选择文件进行上传", - "xpack.fileUpload.jsonIndexFilePicker.fileProcessingError": "文件处理错误：{errorMessage}", - "xpack.fileUpload.jsonIndexFilePicker.formatsAccepted": "接受的格式：{acceptedFileTypeStringMessage}", - "xpack.fileUpload.jsonIndexFilePicker.maxSize": "最大大小：{maxFileSize}", - "xpack.fileUpload.jsonIndexFilePicker.noFileNameError": "未提供任何文件名称", - "xpack.fileUpload.jsonIndexFilePicker.parsingFile": "已处理 {featuresProcessed} 个特征......", - "xpack.fileUpload.jsonIndexFilePicker.unableParseFile": "无法解析文件：{error}", - "xpack.fileUpload.jsonUploadAndParse.creatingIndexPattern": "正在创建索引模式", "xpack.fileUpload.jsonUploadAndParse.dataIndexingError": "数据索引错误", - "xpack.fileUpload.jsonUploadAndParse.dataIndexingStarted": "数据索引已启动", - "xpack.fileUpload.jsonUploadAndParse.indexingComplete": "索引完成", - "xpack.fileUpload.jsonUploadAndParse.indexPatternComplete": "索引模式完成", "xpack.fileUpload.jsonUploadAndParse.indexPatternError": "索引模式错误", - "xpack.fileUpload.jsonUploadAndParse.writingToIndex": "正在写入索引", "xpack.fleet.agentBulkActions.agentsSelected": "已选择 {count, plural, other {# 个代理}}", "xpack.fleet.agentBulkActions.clearSelection": "清除所选内容", "xpack.fleet.agentBulkActions.reassignPolicy": "分配到新策略", @@ -13449,9 +13429,6 @@ "xpack.ml.management.syncSavedObjectsFlyout.sync.error": "一些作业无法同步。", "xpack.ml.management.syncSavedObjectsFlyout.sync.success": "{successCount} 个{successCount, plural, other {作业}}已同步", "xpack.ml.management.syncSavedObjectsFlyout.syncButton": "同步", - "xpack.ml.maxFileSizeSettingsDescription": "设置在文件数据可视化工具中导入数据时的文件大小限制。此设置支持的最高值为 1GB。", - "xpack.ml.maxFileSizeSettingsError": "应为有效的数据大小。如 200MB、1GB", - "xpack.ml.maxFileSizeSettingsName": "文件数据可视化工具最大文件上传大小", "xpack.ml.models.jobService.allOtherRequestsCancelledDescription": " 所有其他请求已取消。", "xpack.ml.models.jobService.categorization.messages.failureToGetTokens": "无法对示例字段值样本进行分词。{message}", "xpack.ml.models.jobService.categorization.messages.insufficientPrivileges": "由于权限不足，无法对字段值示例执行分词。因此，无法检查字段值是否适合用于归类作业。", diff --git a/x-pack/test/functional/apps/maps/import_geojson/file_indexing_panel.js b/x-pack/test/functional/apps/maps/import_geojson/file_indexing_panel.js index 0ce9b7022b38d..a5b376cbb33a5 100644 --- a/x-pack/test/functional/apps/maps/import_geojson/file_indexing_panel.js +++ b/x-pack/test/functional/apps/maps/import_geojson/file_indexing_panel.js @@ -13,6 +13,7 @@ export default function ({ getService, getPageObjects }) { const PageObjects = getPageObjects(['maps', 'common']); const log = getService('log'); const security = getService('security'); + const browser = getService('browser'); const IMPORT_FILE_PREVIEW_NAME = 'Import File'; const FILE_LOAD_DIR = 'test_upload_files'; @@ -102,6 +103,9 @@ export default function ({ getService, getPageObjects }) { const pointGeojsonFiles = ['point.json', 'multi_point.json']; pointGeojsonFiles.forEach(async (pointFile) => { it(`should index with type geo_point for file: ${pointFile}`, async () => { + if (!(await browser.checkBrowserPermission('clipboard-read'))) { + return; + } await loadFileAndIndex(pointFile); const indexPatternResults = await PageObjects.maps.getIndexPatternResults(); const coordinatesField = indexPatternResults.fields.find( @@ -120,6 +124,9 @@ export default function ({ getService, getPageObjects }) { ]; nonPointGeojsonFiles.forEach(async (shapeFile) => { it(`should index with type geo_shape for file: ${shapeFile}`, async () => { + if (!(await browser.checkBrowserPermission('clipboard-read'))) { + return; + } await loadFileAndIndex(shapeFile); const indexPatternResults = await PageObjects.maps.getIndexPatternResults(); const coordinatesField = indexPatternResults.fields.find( diff --git a/x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json b/x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json new file mode 100644 index 0000000000000..a0f384a96e6b4 --- /dev/null +++ b/x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json @@ -0,0 +1,31 @@ +{ "type": "doc", "value": { "id": "config:7.0.0", "index": ".kibana_1", "source": { "config": { "buildNum": 9007199254740991, "dateFormat:tz": "UTC", "defaultIndex": "5193f870-d861-11e9-a311-0fa548c5f953" }, "migrationVersion": { "config": "7.13.0" }, "references": [ ], "type": "config", "updated_at": "2019-09-16T09:06:51.201Z" } } } + +{ "type": "doc", "value": { "id": "config:8.0.0", "index": ".kibana_1", "source": { "config": { "buildNum": 9007199254740991, "dateFormat:tz": "UTC", "defaultIndex": "5193f870-d861-11e9-a311-0fa548c5f953" }, "migrationVersion": { "config": "7.13.0" }, "references": [ ], "type": "config", "updated_at": "2019-12-11T23:22:12.698Z" } } } + +{ "type": "doc", "value": { "id": "index-pattern:5193f870-d861-11e9-a311-0fa548c5f953", "index": ".kibana_1", "source": { "index-pattern": { "fields": "[{\"name\":\"_id\",\"type\":\"string\",\"esTypes\":[\"_id\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":false},{\"name\":\"_index\",\"type\":\"string\",\"esTypes\":[\"_index\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":false},{\"name\":\"_score\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"searchable\":false,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"_source\",\"type\":\"_source\",\"esTypes\":[\"_source\"],\"count\":0,\"scripted\":false,\"searchable\":false,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"_type\",\"type\":\"string\",\"esTypes\":[\"_type\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":false},{\"name\":\"category\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"category.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"category\"}}},{\"name\":\"currency\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"customer_birth_date\",\"type\":\"date\",\"esTypes\":[\"date\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"customer_first_name\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"customer_first_name.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"customer_first_name\"}}},{\"name\":\"customer_full_name\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"customer_full_name.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"customer_full_name\"}}},{\"name\":\"customer_gender\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"customer_id\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"customer_last_name\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"customer_last_name.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"customer_last_name\"}}},{\"name\":\"customer_phone\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"day_of_week\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"day_of_week_i\",\"type\":\"number\",\"esTypes\":[\"integer\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"email\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"geoip.city_name\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"geoip.continent_name\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"geoip.country_iso_code\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"geoip.location\",\"type\":\"geo_point\",\"esTypes\":[\"geo_point\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"geoip.region_name\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"manufacturer\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"manufacturer.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"manufacturer\"}}},{\"name\":\"order_date\",\"type\":\"date\",\"esTypes\":[\"date\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"order_id\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products._id\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"products._id.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"products._id\"}}},{\"name\":\"products.base_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.base_unit_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.category\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"products.category.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"products.category\"}}},{\"name\":\"products.created_on\",\"type\":\"date\",\"esTypes\":[\"date\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.discount_amount\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.discount_percentage\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.manufacturer\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"products.manufacturer.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"products.manufacturer\"}}},{\"name\":\"products.min_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.product_id\",\"type\":\"number\",\"esTypes\":[\"long\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.product_name\",\"type\":\"string\",\"esTypes\":[\"text\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":false,\"readFromDocValues\":false},{\"name\":\"products.product_name.keyword\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true,\"subType\":{\"multi\":{\"parent\":\"products.product_name\"}}},{\"name\":\"products.quantity\",\"type\":\"number\",\"esTypes\":[\"integer\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.sku\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.tax_amount\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.taxful_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.taxless_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"products.unit_discount_amount\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"sku\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":1,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"taxful_total_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"taxless_total_price\",\"type\":\"number\",\"esTypes\":[\"half_float\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"total_quantity\",\"type\":\"number\",\"esTypes\":[\"integer\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"total_unique_products\",\"type\":\"number\",\"esTypes\":[\"integer\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"type\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true},{\"name\":\"user\",\"type\":\"string\",\"esTypes\":[\"keyword\"],\"count\":0,\"scripted\":false,\"searchable\":true,\"aggregatable\":true,\"readFromDocValues\":true}]", "timeFieldName": "order_date", "title": "ecommerce" }, "migrationVersion": { "index-pattern": "7.11.0" }, "references": [ ], "type": "index-pattern", "updated_at": "2019-12-11T23:24:13.381Z" } } } + +{ "type": "doc", "value": { "id": "search:6091ead0-1c6d-11ea-a100-8589bb9d7c6b", "index": ".kibana_1", "source": { "migrationVersion": { "search": "7.9.3" }, "references": [ { "id": "5193f870-d861-11e9-a311-0fa548c5f953", "name": "kibanaSavedObjectMeta.searchSourceJSON.index", "type": "index-pattern" } ], "search": { "columns": [ "category", "currency", "customer_id", "order_id", "day_of_week_i", "order_date", "products.created_on", "sku" ], "description": "", "hits": 0, "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"highlightAll\":true,\"version\":true,\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" }, "sort": [ [ "order_date", "desc" ] ], "title": "Ecommerce Data", "version": 1 }, "type": "search", "updated_at": "2019-12-11T23:24:28.540Z" } } } + +{ "type": "doc", "value": { "id": "dashboard:constructed-sample-saved-object-id", "index": ".kibana_1", "source": { "dashboard": { "description": "", "hits": 0, "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[]}" }, "optionsJSON": "{\"hidePanelTitles\":true,\"useMargins\":true}", "panelsJSON": "[{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":0,\"w\":24,\"h\":15,\"i\":\"1c12c2f2-80c2-4d5c-b722-55b2415006e1\"},\"panelIndex\":\"1c12c2f2-80c2-4d5c-b722-55b2415006e1\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_0\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":24,\"y\":0,\"w\":24,\"h\":15,\"i\":\"1c4b99e1-7785-444f-a1c5-f592893b1a96\"},\"panelIndex\":\"1c4b99e1-7785-444f-a1c5-f592893b1a96\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_1\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":15,\"w\":48,\"h\":18,\"i\":\"94eab06f-60ac-4a85-b771-3a8ed475c9bb\"},\"panelIndex\":\"94eab06f-60ac-4a85-b771-3a8ed475c9bb\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_2\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":33,\"w\":48,\"h\":8,\"i\":\"52c19b6b-7117-42ac-a74e-c507a1c3ffc0\"},\"panelIndex\":\"52c19b6b-7117-42ac-a74e-c507a1c3ffc0\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_3\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":41,\"w\":11,\"h\":10,\"i\":\"a1e889dc-b80e-4937-a576-979f34d1859b\"},\"panelIndex\":\"a1e889dc-b80e-4937-a576-979f34d1859b\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_4\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":11,\"y\":41,\"w\":5,\"h\":10,\"i\":\"4930b035-d756-4cc5-9a18-1af9e67d6f31\"},\"panelIndex\":\"4930b035-d756-4cc5-9a18-1af9e67d6f31\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_5\"}]", "refreshInterval": { "pause": true, "value": 0 }, "timeFrom": "2019-06-26T06:20:28.066Z", "timeRestore": true, "timeTo": "2019-06-26T07:27:58.573Z", "title": "Ecom Dashboard Hidden Panel Titles", "version": 1 }, "migrationVersion": { "dashboard": "7.11.0" }, "references": [ { "id": "0a464230-79f0-11ea-ae7f-13c5d6e410a0", "name": "panel_0", "type": "visualization" }, { "id": "200609c0-79f0-11ea-ae7f-13c5d6e410a0", "name": "panel_1", "type": "visualization" }, { "id": "6091ead0-1c6d-11ea-a100-8589bb9d7c6b", "name": "panel_2", "type": "search" }, { "id": "4a36acd0-7ac3-11ea-b69c-cf0d7935cd67", "name": "panel_3", "type": "visualization" }, { "id": "ef8757d0-7ac2-11ea-b69c-cf0d7935cd67", "name": "panel_4", "type": "visualization" }, { "id": "132ab9c0-7ac3-11ea-b69c-cf0d7935cd67", "name": "panel_5", "type": "visualization" } ], "type": "dashboard", "updated_at": "2020-04-10T00:37:48.462Z" } } } + +{ "type": "doc", "value": { "id": "visualization:0a464230-79f0-11ea-ae7f-13c5d6e410a0", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ { "id": "5193f870-d861-11e9-a311-0fa548c5f953", "name": "kibanaSavedObjectMeta.searchSourceJSON.index", "type": "index-pattern" } ], "type": "visualization", "updated_at": "2020-04-08T23:24:05.971Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" }, "title": "e-commerce area chart", "uiStateJSON": "{}", "version": 1, "visState": "{\"type\":\"area\",\"aggs\":[{\"id\":\"1\",\"enabled\":true,\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"enabled\":true,\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"order_date\",\"timeRange\":{\"from\":\"2019-06-26T06:20:28.066Z\",\"to\":\"2019-06-26T07:27:58.573Z\"},\"useNormalizedEsInterval\":true,\"scaleMetricValues\":false,\"interval\":\"auto\",\"drop_partials\":false,\"min_doc_count\":1,\"extended_bounds\":{}}}],\"params\":{\"type\":\"area\",\"grid\":{\"categoryLines\":false},\"categoryAxes\":[{\"id\":\"CategoryAxis-1\",\"type\":\"category\",\"position\":\"bottom\",\"show\":true,\"style\":{},\"scale\":{\"type\":\"linear\"},\"labels\":{\"show\":true,\"filter\":true,\"truncate\":100},\"title\":{}}],\"valueAxes\":[{\"id\":\"ValueAxis-1\",\"name\":\"LeftAxis-1\",\"type\":\"value\",\"position\":\"left\",\"show\":true,\"style\":{},\"scale\":{\"type\":\"linear\",\"mode\":\"normal\"},\"labels\":{\"show\":true,\"rotate\":0,\"filter\":false,\"truncate\":100},\"title\":{\"text\":\"Count\"}}],\"seriesParams\":[{\"show\":true,\"type\":\"area\",\"mode\":\"stacked\",\"data\":{\"label\":\"Count\",\"id\":\"1\"},\"drawLinesBetweenPoints\":true,\"lineWidth\":2,\"showCircles\":true,\"interpolate\":\"linear\",\"valueAxis\":\"ValueAxis-1\"}],\"addTooltip\":true,\"addLegend\":true,\"legendPosition\":\"right\",\"times\":[],\"addTimeMarker\":false,\"thresholdLine\":{\"show\":false,\"value\":10,\"width\":1,\"style\":\"full\",\"color\":\"#E7664C\"},\"labels\":{},\"isVislibVis\":true,\"detailedTooltip\":true,\"fittingFunction\":\"zero\"},\"title\":\"e-commerce area chart\"}" } } } } + +{ "type": "doc", "value": { "id": "visualization:200609c0-79f0-11ea-ae7f-13c5d6e410a0", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ { "id": "5193f870-d861-11e9-a311-0fa548c5f953", "name": "kibanaSavedObjectMeta.searchSourceJSON.index", "type": "index-pattern" } ], "type": "visualization", "updated_at": "2020-04-08T23:24:42.460Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" }, "title": "e-commerce pie chart", "uiStateJSON": "{}", "version": 1, "visState": "{\"type\":\"pie\",\"aggs\":[{\"id\":\"1\",\"enabled\":true,\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"enabled\":true,\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"order_date\",\"timeRange\":{\"from\":\"2019-06-26T06:20:28.066Z\",\"to\":\"2019-06-26T07:27:58.573Z\"},\"useNormalizedEsInterval\":true,\"scaleMetricValues\":false,\"interval\":\"auto\",\"drop_partials\":false,\"min_doc_count\":1,\"extended_bounds\":{}}}],\"params\":{\"type\":\"pie\",\"addTooltip\":true,\"addLegend\":true,\"legendPosition\":\"right\",\"isDonut\":true,\"labels\":{\"show\":false,\"values\":true,\"last_level\":true,\"truncate\":100}},\"title\":\"e-commerce pie chart\"}" } } } } + +{ "type": "doc", "value": { "id": "visualization:ef8757d0-7ac2-11ea-b69c-cf0d7935cd67", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ { "id": "5193f870-d861-11e9-a311-0fa548c5f953", "name": "kibanaSavedObjectMeta.searchSourceJSON.index", "type": "index-pattern" } ], "type": "visualization", "updated_at": "2020-04-10T00:33:44.909Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\",\"filter\":[]}" }, "title": "게이지", "uiStateJSON": "{}", "version": 1, "visState": "{\"type\":\"gauge\",\"aggs\":[{\"id\":\"1\",\"enabled\":true,\"type\":\"count\",\"schema\":\"metric\",\"params\":{}}],\"params\":{\"type\":\"gauge\",\"addTooltip\":true,\"addLegend\":true,\"isDisplayWarning\":false,\"gauge\":{\"alignment\":\"automatic\",\"extendRange\":true,\"percentageMode\":false,\"gaugeType\":\"Arc\",\"gaugeStyle\":\"Full\",\"backStyle\":\"Full\",\"orientation\":\"vertical\",\"colorSchema\":\"Green to Red\",\"gaugeColorMode\":\"Labels\",\"colorsRange\":[{\"from\":0,\"to\":50},{\"from\":50,\"to\":75},{\"from\":75,\"to\":100}],\"invertColors\":false,\"labels\":{\"show\":true,\"color\":\"black\"},\"scale\":{\"show\":true,\"labels\":false,\"color\":\"rgba(105,112,125,0.2)\"},\"type\":\"meter\",\"style\":{\"bgWidth\":0.9,\"width\":0.9,\"mask\":false,\"bgMask\":false,\"maskBars\":50,\"bgFill\":\"rgba(105,112,125,0.2)\",\"bgColor\":true,\"subText\":\"\",\"fontSize\":60}}},\"title\":\"게이지\"}" } } } } + +{ "type": "doc", "value": { "id": "visualization:132ab9c0-7ac3-11ea-b69c-cf0d7935cd67", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ { "id": "5193f870-d861-11e9-a311-0fa548c5f953", "name": "kibanaSavedObjectMeta.searchSourceJSON.index", "type": "index-pattern" } ], "type": "visualization", "updated_at": "2020-04-10T00:34:44.700Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\",\"filter\":[]}" }, "title": "Українська", "uiStateJSON": "{}", "version": 1, "visState": "{\"type\":\"metric\",\"aggs\":[{\"id\":\"1\",\"enabled\":true,\"type\":\"count\",\"schema\":\"metric\",\"params\":{}}],\"params\":{\"addTooltip\":true,\"addLegend\":false,\"type\":\"metric\",\"metric\":{\"percentageMode\":false,\"useRanges\":false,\"colorSchema\":\"Green to Red\",\"metricColorMode\":\"None\",\"colorsRange\":[{\"from\":0,\"to\":10000}],\"labels\":{\"show\":true},\"invertColors\":false,\"style\":{\"bgFill\":\"#000\",\"bgColor\":false,\"labelColor\":false,\"subText\":\"\",\"fontSize\":60}}},\"title\":\"Українська\"}" } } } } + +{ "type": "doc", "value": { "id": "visualization:4a36acd0-7ac3-11ea-b69c-cf0d7935cd67", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ ], "type": "visualization", "updated_at": "2020-04-10T00:36:17.053Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" }, "title": "Tiểu thuyết", "uiStateJSON": "{}", "version": 1, "visState": "{\"type\":\"markdown\",\"aggs\":[],\"params\":{\"fontSize\":12,\"openLinksInNewTab\":false,\"markdown\":\"Tiểu thuyết là một thể loại văn xuôi có hư cấu, thông qua nhân vật, hoàn cảnh, sự việc để phản ánh bức tranh xã hội rộng lớn và những vấn đề của cuộc sống con người, biểu hiện tính chất tường thuật, tính chất kể chuyện bằng ngôn ngữ văn xuôi theo những chủ đề xác định.\\n\\nTrong một cách hiểu khác, nhận định của Belinski: \\\"tiểu thuyết là sử thi của đời tư\\\" chỉ ra khái quát nhất về một dạng thức tự sự, trong đó sự trần thuật tập trung vào số phận của một cá nhân trong quá trình hình thành và phát triển của nó. Sự trần thuật ở đây được khai triển trong không gian và thời gian nghệ thuật đến mức đủ để truyền đạt cơ cấu của nhân cách[1].\\n\\n\\n[1]^ Mục từ Tiểu thuyết trong cuốn 150 thuật ngữ văn học, Lại Nguyên Ân biên soạn, Nhà xuất bản Đại học Quốc gia Hà Nội, in lần thứ 2 có sửa đổi bổ sung. H. 2003. Trang 326.\"},\"title\":\"Tiểu thuyết\"}" } } } } + +{ "type": "doc", "value": { "id": "space:default", "index": ".kibana_1", "source": { "space": { "_reserved": true, "description": "This is the default space", "disabledFeatures": [ ], "name": "Default Space" }, "type": "space", "updated_at": "2021-01-07T00:17:12.785Z" } } } + +{ "type": "doc", "value": { "id": "ui-counter:visualize:06012021:click:tagcloud", "index": ".kibana_1", "source": { "type": "ui-counter", "ui-counter": { "count": 1 }, "updated_at": "2021-01-07T00:18:52.592Z" } } } + +{ "type": "doc", "value": { "id": "ui-counter:data_plugin:06012021:click:discover:query_submitted", "index": ".kibana_1", "source": { "type": "ui-counter", "ui-counter": { "count": 1 }, "updated_at": "2021-01-07T00:18:52.592Z" } } } + +{ "type": "doc", "value": { "id": "dashboard:6c263e00-1c6d-11ea-a100-8589bb9d7c6b", "index": ".kibana_1", "source": { "dashboard": { "description": "", "hits": 0, "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[]}" }, "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", "panelsJSON": "[{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":0,\"w\":24,\"h\":15,\"i\":\"1c12c2f2-80c2-4d5c-b722-55b2415006e1\"},\"panelIndex\":\"1c12c2f2-80c2-4d5c-b722-55b2415006e1\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_0\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":24,\"y\":0,\"w\":24,\"h\":15,\"i\":\"1c4b99e1-7785-444f-a1c5-f592893b1a96\"},\"panelIndex\":\"1c4b99e1-7785-444f-a1c5-f592893b1a96\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_1\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":35,\"w\":48,\"h\":18,\"i\":\"94eab06f-60ac-4a85-b771-3a8ed475c9bb\"},\"panelIndex\":\"94eab06f-60ac-4a85-b771-3a8ed475c9bb\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_2\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":15,\"w\":48,\"h\":8,\"i\":\"52c19b6b-7117-42ac-a74e-c507a1c3ffc0\"},\"panelIndex\":\"52c19b6b-7117-42ac-a74e-c507a1c3ffc0\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_3\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":0,\"y\":23,\"w\":16,\"h\":12,\"i\":\"a1e889dc-b80e-4937-a576-979f34d1859b\"},\"panelIndex\":\"a1e889dc-b80e-4937-a576-979f34d1859b\",\"embeddableConfig\":{\"enhancements\":{},\"vis\":null},\"panelRefName\":\"panel_4\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":16,\"y\":23,\"w\":12,\"h\":12,\"i\":\"4930b035-d756-4cc5-9a18-1af9e67d6f31\"},\"panelIndex\":\"4930b035-d756-4cc5-9a18-1af9e67d6f31\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_5\"},{\"version\":\"8.0.0\",\"gridData\":{\"x\":28,\"y\":23,\"w\":20,\"h\":12,\"i\":\"55112375-d6f0-44f7-a8fb-867c8f7d464d\"},\"panelIndex\":\"55112375-d6f0-44f7-a8fb-867c8f7d464d\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_6\"}]", "refreshInterval": { "pause": true, "value": 0 }, "timeFrom": "2019-03-23T03:06:17.785Z", "timeRestore": true, "timeTo": "2019-10-04T02:33:16.708Z", "title": "Ecom Dashboard", "version": 1 }, "migrationVersion": { "dashboard": "7.11.0" }, "references": [ { "id": "0a464230-79f0-11ea-ae7f-13c5d6e410a0", "name": "panel_0", "type": "visualization" }, { "id": "200609c0-79f0-11ea-ae7f-13c5d6e410a0", "name": "panel_1", "type": "visualization" }, { "id": "6091ead0-1c6d-11ea-a100-8589bb9d7c6b", "name": "panel_2", "type": "search" }, { "id": "4a36acd0-7ac3-11ea-b69c-cf0d7935cd67", "name": "panel_3", "type": "visualization" }, { "id": "ef8757d0-7ac2-11ea-b69c-cf0d7935cd67", "name": "panel_4", "type": "visualization" }, { "id": "132ab9c0-7ac3-11ea-b69c-cf0d7935cd67", "name": "panel_5", "type": "visualization" }, { "id": "1bba55f0-507e-11eb-9c0d-97106882b997", "name": "panel_6", "type": "visualization" } ], "type": "dashboard", "updated_at": "2021-01-07T00:22:16.102Z" } } } + +{ "type": "doc", "value": { "id": "visualization:1bba55f0-507e-11eb-9c0d-97106882b997", "index": ".kibana_1", "source": { "migrationVersion": { "visualization": "7.12.0" }, "references": [ { "id": "6091ead0-1c6d-11ea-a100-8589bb9d7c6b", "name": "search_0", "type": "search" } ], "type": "visualization", "updated_at": "2021-01-07T00:23:04.624Z", "visualization": { "description": "", "kibanaSavedObjectMeta": { "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" }, "savedSearchRefName": "search_0", "title": "Tag Cloud of Names", "uiStateJSON": "{}", "version": 1, "visState": "{\"title\":\"Tag Cloud of Names\",\"type\":\"tagcloud\",\"aggs\":[{\"id\":\"1\",\"enabled\":true,\"type\":\"count\",\"params\":{},\"schema\":\"metric\"},{\"id\":\"2\",\"enabled\":true,\"type\":\"terms\",\"params\":{\"field\":\"customer_first_name.keyword\",\"orderBy\":\"1\",\"order\":\"desc\",\"size\":10,\"otherBucket\":false,\"otherBucketLabel\":\"Other\",\"missingBucket\":false,\"missingBucketLabel\":\"Missing\"},\"schema\":\"segment\"}],\"params\":{\"scale\":\"linear\",\"orientation\":\"single\",\"minFontSize\":18,\"maxFontSize\":72,\"showLabel\":true}}" } } } } + +{ "type": "doc", "value": { "id": "ui-counter:DashboardPanelVersionInUrl:06012021:loaded:8.0.0", "index": ".kibana_1", "source": { "type": "ui-counter", "ui-counter": { "count": 85 }, "updated_at": "2021-01-07T00:23:25.741Z" } } } diff --git a/x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json.gz b/x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json.gz deleted file mode 100644 index 8b2b8f9c114de2968d1ebb6395c1af082486c6a0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4526 zcmV;f5mD|RiwFqyRQ6v217u-zVJ>QOZ*BnXUCnRg#+AS4uOK>?U7*=0emDDOk3DNI zMzUjdCV)q?jUrjyUE6H3%@2KeARyixf<+QweFzr8!dOoXW02h)th4b+!XgJ5K9Bzd zT^IQy_EiEGt%lwEiZIiZK<_~{ghol zlUmec?QR$h>8NLQPzSLNH1Nm)yV03Y2M2hdu+}(CBR3l-Mu^W&N_}rTox+ukkfqqR zYUq}ZY+Hd*9!|)^Fq-0|mwd`-{|4V-m&iqlTzub!=dRca6x9L?m!Y3^$%gPup`@Wc{Hf zoiU8w04J7A^04-5uJfZ;Btuln6M^-BX^7)pOH(Vl(pf}C?X@A zR9hp0y@ydaeJ6AuGr`0;m7{hQA!DW~NYVFJaK>&Jkt)t0ojN4qZR^0v8*6y-=Ei`y zMN|=$8>^zrZ#=ynumWKtC5s-np<@@;|0s+On*mM8K~lx3TpH(^;>>||CggBGj2f=- zqVr!}w%M&Xb@~DnfS-bwr{d!bgELNQB0oB+@t8);WglLFH|4LzTODbfgi{g?92zC# z0gED4&_zoHvS_^#U97-6q*0sm-B%vaQI|B!vc}jS z4u*b+Z^zqLai;-IHWB<)&tPwUNxVLXu}hS&a&fpY6?|t?G?R>z1N^jaK*hiQc>$4K^`=Y$Rm2sagfmD@CrwUH*IF|B)$7b76sY_A8cfH0l0^$zlpvckozQ#HxWAD zpKW4NdbKrqLur3z(n*-$O)~7kkd;VY_WS|nlL!1y@KnqwCAj| z(XjN!bTszifAW^^&)318(9^sDoE{zNQ8-}Cm zih+Saf;7-x3k{NHE6W+orG&XWTwJDyAr}4c;(748R(E zb3QL-Tz71nD6(aB4O!RqA^3FHkcWn?c5Tg3ux+kjyve|8VO&|0@m%4YO~$z1%^B|& zjN3ZF4l;+biLfi{7?^M@OOZ9)C7x~>E`+qDj5iy2EsU#|WL(qgjL-QtR9CSb(~&Jj zv1DBZ9!8le(w`+T_KD&s>x~*9< zHY`)NEqkcxp3*h!fDRWE>D92Wf`vS%xX=E-X?TD_vQ^Lz|eE zXAZUHzOC87Yhl~~06e9JbT1;hQ}yP6>Dn6@jsL*!YuX1Jbd zEt1t5f+n!PFf2h`ZA@KnNL|rX>~MjvgWWifdSzcYx348xtcql$%L?iv)YB}86CK@D z*UDlmbN8Cs=4H2rRZhi%Q7>9Bx4K1KuA`NzK;3LZfsBrADctSUnO>gSUn!rz#l747 zbVM$;Wf=Cjk~_w*t7DR)I|+!YKz>wnu0lk-PsUksO2i0pj__#24~XC<07N_U2J0?>s>KREAQJ1&QaD=CMK%0|QFCfd5J{VJoKVaX}I{lc8rX-to zKEbYd6?{B)&w0coE8vt7gg>I$ZtSSKf%bUO7+08QbaZjW18fdnG+^Sn5l9c?w2H# z9P&fNXGgiXYN&mHh9eJF!#Vi!MD4PtIpWrj_qi>;O_F^=f)7~@f9bq~ ziRWk3OIX^jX3~8?Be!xW!WY&o^aZ;WneOH4T~s#b8GBwo4E==8N~hhP_lU4J3rjHg z^@nAJN9-K1a5r)8{~1BJ-onwOs*f>C-9z7F+*Z_?_s9%O>`wMGo|TdfftFL>&wdMn zA4a_C$M0IEsXwS23%jE6V;cL^c}z>P@*w(9@WKmR4{4InVDu2orr_~Y5`}_tZallo zBa#SQm(Gxy=GXTb(nT4Pu0pbk-p~wbM#;4#NI>U4KY9c5qe9Qu5CmxaP8g&~srO>w zu6X)#kYg|S`ecvzEAyF^KDe;?E4tvO`}unpeExZX*3 z&#(XT#kYTX@$)PC-4RYlH{p3#I)oB{W-b9%J&k8RKKvPu0$zGiEb@#NqYox93Z{8E zDf4Voun2)mxUAe8XJqGZA8d&PyF#>|!+k3fGQ=SO~pI(d5-vua1BC z`Kxb!_}5qe`@?5H{QA}Lt8cCtSW0o=W+Tf*VWc=6Sb{YF$lpd-6%Zid=FWD(bDihH z1?8#_-_C!3%*7rYJaXofS2*9J)$Y3D9SeW_UlspeZ(Pr*EiNTp<)9-bZl`KtT;DUK#yxF1v;LwyOCOiN)Wkl~C3 zk7zJ~&FwbX?_;MDvU7q!y@pltPrsC=XD7c)pb73set35LoJxD&{UVSK($jCL9@g1`Xt3tFh2c#AnlzUzf9WFI6VC_V4c1S#%(D+JNcuu2Xp<> zmA?C&5uT0NE$Q@mFqWLNlRvmp5@Gm!aQc-5GyjfC5qt;A{@KaD0ad^iK>L3~3(W9! zz{z|D6P&!jlAA(bm(B7y+;_u33P#_5b9V9tZA*^eaLgtL2Xp!oCUIf%uYpD02Sxz< z0(Ir~gyD3VWY|dO?D&t+H5dWE@ExF(rIL(ESOA3aCoeL92dB>k%fAZ7o!#94zWPxJ zorIKKxIO0J0OMo~S8Yb-_+^j}%2<4x_%w(ov?uNEGQY8?HsJmxw9sq-8~z1lJhA~C z(?3fQ=95s+*Xi?w&jgI_F`xpE2kPbm5h`J7W4Z&$aM0g<4%+9+Oro>n7eOvL=z08d z#%eN{eons(xh}YpUj`YVg5k_i1Vsh}KA!#;a60DS!J@u|A57!3F+&M)0JzP`1gC%M zNIOd)oSpnT!}t3`_|6pjl?%LLS_~KSO@zIUC>BP=I0Z5B>tF;IzbpuX1dsn5Fx-C- zDtwXIF0ctU@flaqF#vSGe=e3o4w3W6Rr^GFnrR)r;Nl;ot+SJ_xn%!SsxLl)kQwvm zfutCyKvFU{K=>Q5kw<)4ZjaK#)Bk`~^iN=)lzocXdJWprHV6?+ldIR^EA6{~;Y0X% z=_hOsmvJq<2OYQBf@@1OfYl~M3Oq|HU+c`Qgf;z^vX%NR1Sk%h%&-JN0=|KwS`eE9z_Bfw$PFX~(;wmeWhl`>h>Ri6MJwxpnwt88<*rU0@ z%uh!&sB^|&k%PF|<57A5Db|$24rZe`omY>Wu4-xoUBl}buSxxQX~S?|Kz?69e)R%! z?M*EpU#y&eGYZJnyl`GIbA_vSuYjCAUgPx+LF)V0Sxs&(h(TQx!={vzujT2wb?$D9DrsZ~rmZzJ#x7_j@4ZIf4&Fd_r*JM@eBaQt9AjJ~7 zX2U{yg`L6lk;)zxDrUz*-SZ0R?~CT|i{@{wXueF{aj;>4CLtmbM%|HNE)N{Fg3NAL zg?wcRb@Q4^@=IF-_9vpuj)JaIlHZh>8+|^tu1O2~t**zyrq?_cF3T5un%*&0{mvf? z^Y?*wIQ`7oFNmc$IL0IC0o%As;ZR~d<4c|$&re_$C|2u)^OJ%rKXocSUt0bQYMn|l zkl-{vr&8>qKmWoj$=*IJvA|nIl^WQEcutlbm$Nh>OvW%Ebtfb#?LtefkBS=M4_Kpk zKtxmG=3-Ezz7m;a@C_TX-&)mjP62h3j<@jHXXAK*7V(bAT>C>pv(pS$T1C zj*4%s*F2Of9n=)zpYP%`-|~L&)5xEn+xQ{&h_}vP5nS(-rfXbyOv8#!jgF3MnCs{}#^y%%Jj$ zV_e!!f~OjtQFwL*y;0m(xoD@Gjv>?g!I^p|#LZPt&*N*hu&sUKX5v?(EGq(dU$+N< z;gDqRuuSBRU8*Gy!@y<+=}D7VnrlM0#n#)lk|sflY@7HekL!AUcsisaim& zn1){ZDFu@;KJvwKS@B6++3^k3<6>YFIWe_6^3~%u?pa|}^fcgd3<#w<0DRuu4Z{^S zUvVhl*u+()2f74IIiCo8i#I!MXuVZ_v604@%h&XQMyGw+2%0LDU%Gif!(w5AiU%1;O&fy;L5K@$2`(AW%F;V2Hip;fc`=QYI|?e~X{XZOoH@4xL_a?@R z%2KDj&+s|R9;k#pYeefXN~Z5}(z@2U^r$yQ@jB zG&_D6Zqy7kgn?AEoW<6(vq$(rK!xX)Krz{CR!E&mHVZ| zdQqi+zn(yK|Cgv^k9B$efAWXbKj{p2hss%?os%=U9^Fy`YmEF6FKs#|)|aaSj11m) zQ4(Vs8}%8;66;SN+FmAPis(fP+FQ}~6@GPjq9EF40tdqKbT+ za}TDQ@&XKi%mI@7!N1JMp6-5lrAhf~>df8ni;Q0g||U-)e|*NPbce27lO?x5-XB*WL}# zm-dQke!1lpv_DtYX;=Kj(1x+S)qxds@qw)HJIXY_K)<8&*(a?tI^?}lb0R)yfhXeY zoN5a?X^#=|&>gX4jq;e^cWvUG}l#O!T4m;tyOSUjN!Y(po$$I`K0U^~+aW#zvVx&4Y9&JlgCe#k94x|yx1c37ajF0iW~@bc#oS!g z%GICk5mc%T9bIdUfI$tb_8X5wHrcQNPG#oeyRYo@7xgyFiXGa{^Sqh)_#>4riJNr@ zHxE$B;);!d^%Ux;E2>7BykwF*DAuUk^i^DxPzi}wsm6VOAIgZ+$bz|r|D5praN5q8 z5g(UC81cirPn}^H^OmYAt7)?xS$B1*aHD%TTMbM^&dv=Q2;H%=s1H$4hdZa(X*T8F z)$#GVY%7y9OIRBN?NrnT$b5MOhzU6bT|SWNMq@i!-_&$|S=MDNd{PcctSPQUXT(V? zCN!7?f)ATfJM%N&56)I88A=(z^10vpIWCqv4+wnNt6}89qxZ}Ud9ta1Xg2pnH}2>i zSsJmEHUJl^oNxuy=xxXI0#`Fr%+Gpy>r~nzPB}5~lyZd7lLviDV#|~>x~s3tIwFOT z>wTsx3U@@UN>_SW`sh!C9%VL1L^i;iPx8DruJ!vvSh7RqGr8d?rDuk4iud}CNi{F$ zyMbcehwRa@G~O0pIRynkjAZ@#Y5Vhk1OLCS&^mDzPP&DB?f+E&#dqV@Y=81U#(!gq z?K`~dnE%-rQY-oY)Jv8rjMjSO+w-`aDV#+ioJJl6OZZ_V4Yc$^^ z_D=u?zBk`M4%Us$W~+xD|3=PahuX=>1~Yxji9@sPSF2J)U3`VUIe|z^Ryy{j { layerAddReady = await this.importFileButtonEnabled(); @@ -454,21 +454,20 @@ export function GisPageProvider({ getService, getPageObjects }: FtrProviderConte ); } - async getCodeBlockParsedJson(dataTestSubjName: string) { - log.debug(`Get parsed code block for ${dataTestSubjName}`); - const indexRespCodeBlock = await testSubjects.find(`${dataTestSubjName}`); - const indexRespJson = await indexRespCodeBlock.getAttribute('innerText'); - return JSON.parse(indexRespJson); + async clickCopyButton(dataTestSubj: string): Promise { + log.debug(`Click ${dataTestSubj} copy button`); + + await testSubjects.click(dataTestSubj); + + return await browser.getClipboardValue(); } async getIndexResults() { - log.debug('Get index results'); - return await this.getCodeBlockParsedJson('indexRespCodeBlock'); + return JSON.parse(await this.clickCopyButton('indexRespCopyButton')); } async getIndexPatternResults() { - log.debug('Get index pattern results'); - return await this.getCodeBlockParsedJson('indexPatternRespCodeBlock'); + return JSON.parse(await this.clickCopyButton('indexPatternRespCopyButton')); } async setLayerQuery(layerName: string, query: string) { From a36b64e7a84ddb696836e2c1d79403838c0698eb Mon Sep 17 00:00:00 2001 From: Tiago Costa Date: Wed, 3 Mar 2021 02:09:36 +0000 Subject: [PATCH 16/52] chore(NA): look for bazel packages on npm_module folder during distributable build (#93262) --- packages/kbn-pm/dist/index.js | 11 +++++------ .../build_bazel_production_projects.ts | 17 ++++------------- 2 files changed, 9 insertions(+), 19 deletions(-) diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index f9ddbcac1e09d..df9ab9b5515a9 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -59803,7 +59803,7 @@ __webpack_require__.r(__webpack_exports__); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(4); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_2__); /* harmony import */ var _build_non_bazel_production_projects__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(745); -/* harmony import */ var _utils_bazel_run__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(374); +/* harmony import */ var _utils_bazel__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(371); /* harmony import */ var _utils_fs__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(131); /* harmony import */ var _utils_log__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(246); /* harmony import */ var _utils_package_json__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(251); @@ -59832,7 +59832,7 @@ async function buildBazelProductionProjects({ const projects = await Object(_utils_projects__WEBPACK_IMPORTED_MODULE_8__["getBazelProjectsOnly"])(await Object(_build_non_bazel_production_projects__WEBPACK_IMPORTED_MODULE_3__["getProductionProjects"])(kibanaRoot, onlyOSS)); const projectNames = [...projects.values()].map(project => project.name); _utils_log__WEBPACK_IMPORTED_MODULE_6__["log"].info(`Preparing Bazel projects production build for [${projectNames.join(', ')}]`); - await Object(_utils_bazel_run__WEBPACK_IMPORTED_MODULE_4__["runBazel"])(['build', '//packages:build']); + await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_4__["runBazel"])(['build', '//packages:build']); _utils_log__WEBPACK_IMPORTED_MODULE_6__["log"].info(`All Bazel projects production builds for [${projectNames.join(', ')}] are complete}]`); for (const project of projects.values()) { @@ -59856,9 +59856,8 @@ async function copyToBuild(project, kibanaRoot, buildRoot) { // We want the package to have the same relative location within the build const relativeProjectPath = Object(path__WEBPACK_IMPORTED_MODULE_2__["relative"])(kibanaRoot, project.path); const buildProjectPath = Object(path__WEBPACK_IMPORTED_MODULE_2__["resolve"])(buildRoot, relativeProjectPath); - const bazelFilesToExclude = ['!*.sh.runfiles*', '!*.params', '!*_mappings.json', '!*_options.optionsvalid.d.ts', '!*_loader.js', '!*_require_patch.js', '!*.sh']; - await cpy__WEBPACK_IMPORTED_MODULE_0___default()(['**/*', '!node_modules/**', ...bazelFilesToExclude], buildProjectPath, { - cwd: Object(path__WEBPACK_IMPORTED_MODULE_2__["join"])(kibanaRoot, 'bazel', 'bin', 'packages', Object(path__WEBPACK_IMPORTED_MODULE_2__["basename"])(buildProjectPath)), + await cpy__WEBPACK_IMPORTED_MODULE_0___default()(['**/*'], buildProjectPath, { + cwd: Object(path__WEBPACK_IMPORTED_MODULE_2__["join"])(kibanaRoot, 'bazel', 'bin', 'packages', Object(path__WEBPACK_IMPORTED_MODULE_2__["basename"])(buildProjectPath), 'npm_module'), dot: true, onlyFiles: true, parents: true @@ -59880,7 +59879,7 @@ async function applyCorrectPermissions(project, kibanaRoot, buildRoot) { const buildProjectPath = Object(path__WEBPACK_IMPORTED_MODULE_2__["resolve"])(buildRoot, relativeProjectPath); const allPluginPaths = await globby__WEBPACK_IMPORTED_MODULE_1___default()([`**/*`], { onlyFiles: false, - cwd: Object(path__WEBPACK_IMPORTED_MODULE_2__["join"])(kibanaRoot, 'bazel', 'bin', 'packages', Object(path__WEBPACK_IMPORTED_MODULE_2__["basename"])(buildProjectPath)), + cwd: Object(path__WEBPACK_IMPORTED_MODULE_2__["join"])(kibanaRoot, 'bazel', 'bin', 'packages', Object(path__WEBPACK_IMPORTED_MODULE_2__["basename"])(buildProjectPath), 'npm_module'), dot: true }); diff --git a/packages/kbn-pm/src/production/build_bazel_production_projects.ts b/packages/kbn-pm/src/production/build_bazel_production_projects.ts index 1034253c5e0dc..313622d44276a 100644 --- a/packages/kbn-pm/src/production/build_bazel_production_projects.ts +++ b/packages/kbn-pm/src/production/build_bazel_production_projects.ts @@ -11,7 +11,7 @@ import globby from 'globby'; import { basename, join, relative, resolve } from 'path'; import { getProductionProjects } from './build_non_bazel_production_projects'; -import { runBazel } from '../utils/bazel/run'; +import { runBazel } from '../utils/bazel'; import { chmod, isFile, isDirectory } from '../utils/fs'; import { log } from '../utils/log'; import { @@ -60,18 +60,9 @@ async function copyToBuild(project: Project, kibanaRoot: string, buildRoot: stri // We want the package to have the same relative location within the build const relativeProjectPath = relative(kibanaRoot, project.path); const buildProjectPath = resolve(buildRoot, relativeProjectPath); - const bazelFilesToExclude = [ - '!*.sh.runfiles*', - '!*.params', - '!*_mappings.json', - '!*_options.optionsvalid.d.ts', - '!*_loader.js', - '!*_require_patch.js', - '!*.sh', - ]; - await copy(['**/*', '!node_modules/**', ...bazelFilesToExclude], buildProjectPath, { - cwd: join(kibanaRoot, 'bazel', 'bin', 'packages', basename(buildProjectPath)), + await copy(['**/*'], buildProjectPath, { + cwd: join(kibanaRoot, 'bazel', 'bin', 'packages', basename(buildProjectPath), 'npm_module'), dot: true, onlyFiles: true, parents: true, @@ -97,7 +88,7 @@ async function applyCorrectPermissions(project: Project, kibanaRoot: string, bui const buildProjectPath = resolve(buildRoot, relativeProjectPath); const allPluginPaths = await globby([`**/*`], { onlyFiles: false, - cwd: join(kibanaRoot, 'bazel', 'bin', 'packages', basename(buildProjectPath)), + cwd: join(kibanaRoot, 'bazel', 'bin', 'packages', basename(buildProjectPath), 'npm_module'), dot: true, }); From 87a5b22626d59ac7a95afd19d31808d98aed5560 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 2 Mar 2021 22:02:17 -0500 Subject: [PATCH 17/52] API DOCS Step 3/3 (#92929) * update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .gitignore | 1 - api_docs/actions.json | 1775 + api_docs/actions.mdx | 41 + api_docs/advanced_settings.json | 301 + api_docs/advanced_settings.mdx | 27 + api_docs/alerts.json | 3419 ++ api_docs/alerts.mdx | 49 + api_docs/apm.json | 808 + api_docs/apm.mdx | 38 + api_docs/apm_oss.json | 635 + api_docs/apm_oss.mdx | 35 + api_docs/banners.json | 165 + api_docs/banners.mdx | 21 + api_docs/beats_management.json | 69 + api_docs/beats_management.mdx | 21 + api_docs/bfetch.json | 1209 + api_docs/bfetch.mdx | 49 + api_docs/canvas.json | 120 + api_docs/canvas.mdx | 24 + api_docs/case.json | 65 + api_docs/case.mdx | 18 + api_docs/charts.json | 2639 ++ api_docs/charts.mdx | 44 + api_docs/cloud.json | 249 + api_docs/cloud.mdx | 26 + api_docs/console.json | 65 + api_docs/console.mdx | 21 + api_docs/core.json | 17763 ++++++++ api_docs/core.mdx | 38 + api_docs/core_application.json | 2007 + api_docs/core_application.mdx | 27 + api_docs/core_chrome.json | 2537 ++ api_docs/core_chrome.mdx | 21 + api_docs/core_http.json | 7035 +++ api_docs/core_http.mdx | 38 + api_docs/core_saved_objects.json | 14001 ++++++ api_docs/core_saved_objects.mdx | 35 + api_docs/dashboard.json | 2610 ++ api_docs/dashboard.mdx | 47 + api_docs/dashboard_enhanced.json | 1086 + api_docs/dashboard_enhanced.mdx | 49 + api_docs/dashboard_mode.json | 252 + api_docs/dashboard_mode.mdx | 23 + api_docs/data.json | 29115 +++++++++++++ api_docs/data.mdx | 85 + api_docs/data_autocomplete.json | 438 + api_docs/data_autocomplete.mdx | 24 + api_docs/data_enhanced.json | 980 + api_docs/data_enhanced.mdx | 43 + api_docs/data_field_formats.json | 4136 ++ api_docs/data_field_formats.mdx | 38 + api_docs/data_index_patterns.json | 7182 ++++ api_docs/data_index_patterns.mdx | 41 + api_docs/data_query.json | 2618 ++ api_docs/data_query.mdx | 41 + api_docs/data_search.json | 20250 +++++++++ api_docs/data_search.mdx | 61 + api_docs/data_ui.json | 539 + api_docs/data_ui.mdx | 24 + api_docs/dev_tools.json | 243 + api_docs/dev_tools.mdx | 21 + api_docs/discover.json | 1153 + api_docs/discover.mdx | 35 + api_docs/discover_enhanced.json | 910 + api_docs/discover_enhanced.mdx | 26 + api_docs/embeddable.json | 9507 +++++ api_docs/embeddable.mdx | 64 + api_docs/embeddable_enhanced.json | 363 + api_docs/embeddable_enhanced.mdx | 30 + api_docs/encrypted_saved_objects.json | 390 + api_docs/encrypted_saved_objects.mdx | 27 + api_docs/enterprise_search.json | 69 + api_docs/enterprise_search.mdx | 21 + api_docs/es_ui_shared.json | 1558 + api_docs/es_ui_shared.mdx | 40 + api_docs/event_log.json | 715 + api_docs/event_log.mdx | 32 + api_docs/expressions.json | 35643 ++++++++++++++++ api_docs/expressions.mdx | 79 + api_docs/features.json | 3713 ++ api_docs/features.mdx | 49 + api_docs/file_upload.json | 1797 + api_docs/file_upload.mdx | 32 + api_docs/fleet.json | 17178 ++++++++ api_docs/fleet.mdx | 73 + api_docs/global_search.json | 1383 + api_docs/global_search.mdx | 41 + api_docs/home.json | 1504 + api_docs/home.mdx | 56 + api_docs/index_lifecycle_management.json | 105 + api_docs/index_lifecycle_management.mdx | 21 + api_docs/index_management.json | 2607 ++ api_docs/index_management.mdx | 43 + api_docs/index_pattern_field_editor.json | 497 + api_docs/index_pattern_field_editor.mdx | 24 + api_docs/index_pattern_management.json | 914 + api_docs/index_pattern_management.mdx | 30 + api_docs/infra.json | 270 + api_docs/infra.mdx | 35 + api_docs/ingest_pipelines.json | 207 + api_docs/ingest_pipelines.mdx | 24 + api_docs/inspector.json | 2061 + api_docs/inspector.mdx | 44 + api_docs/kibana_legacy.json | 1789 + api_docs/kibana_legacy.mdx | 27 + api_docs/kibana_react.json | 4124 ++ api_docs/kibana_react.mdx | 38 + api_docs/kibana_utils.json | 9276 ++++ api_docs/kibana_utils.mdx | 61 + api_docs/lens.json | 2799 ++ api_docs/lens.mdx | 40 + api_docs/license_management.json | 72 + api_docs/license_management.mdx | 21 + api_docs/licensing.json | 2312 + api_docs/licensing.mdx | 50 + api_docs/lists.json | 4664 ++ api_docs/lists.mdx | 49 + api_docs/management.json | 727 + api_docs/management.mdx | 30 + api_docs/maps.json | 437 + api_docs/maps.mdx | 24 + api_docs/maps_legacy.json | 290 + api_docs/maps_legacy.mdx | 26 + api_docs/ml.json | 6312 +++ api_docs/ml.mdx | 76 + api_docs/monitoring.json | 139 + api_docs/monitoring.mdx | 24 + api_docs/navigation.json | 618 + api_docs/navigation.mdx | 33 + api_docs/newsfeed.json | 275 + api_docs/newsfeed.mdx | 27 + api_docs/observability.json | 2469 ++ api_docs/observability.mdx | 50 + api_docs/osquery.json | 152 + api_docs/osquery.mdx | 34 + api_docs/presentation_util.json | 266 + api_docs/presentation_util.mdx | 27 + api_docs/remote_clusters.json | 83 + api_docs/remote_clusters.mdx | 23 + api_docs/reporting.json | 2344 + api_docs/reporting.mdx | 43 + api_docs/rollup.json | 343 + api_docs/rollup.mdx | 21 + api_docs/runtime_fields.json | 441 + api_docs/runtime_fields.mdx | 27 + api_docs/saved_objects.json | 3124 ++ api_docs/saved_objects.mdx | 38 + api_docs/saved_objects_management.json | 1673 + api_docs/saved_objects_management.mdx | 41 + api_docs/saved_objects_tagging.json | 916 + api_docs/saved_objects_tagging.mdx | 32 + api_docs/saved_objects_tagging_oss.json | 1706 + api_docs/saved_objects_tagging_oss.mdx | 32 + api_docs/security.json | 1344 + api_docs/security.mdx | 32 + api_docs/security_oss.json | 231 + api_docs/security_oss.mdx | 31 + api_docs/security_solution.json | 2244 + api_docs/security_solution.mdx | 55 + api_docs/share.json | 1334 + api_docs/share.mdx | 38 + api_docs/snapshot_restore.json | 393 + api_docs/snapshot_restore.mdx | 24 + api_docs/spaces.json | 1592 + api_docs/spaces.mdx | 58 + api_docs/spaces_oss.json | 1230 + api_docs/spaces_oss.mdx | 32 + api_docs/stack_alerts.json | 97 + api_docs/stack_alerts.mdx | 26 + api_docs/task_manager.json | 841 + api_docs/task_manager.mdx | 36 + api_docs/telemetry.json | 820 + api_docs/telemetry.mdx | 41 + api_docs/telemetry_collection_manager.json | 506 + api_docs/telemetry_collection_manager.mdx | 27 + api_docs/telemetry_collection_xpack.json | 175 + api_docs/telemetry_collection_xpack.mdx | 18 + api_docs/telemetry_management_section.json | 234 + api_docs/telemetry_management_section.mdx | 21 + api_docs/triggers_actions_ui.json | 3968 ++ api_docs/triggers_actions_ui.mdx | 61 + api_docs/ui_actions.json | 2530 ++ api_docs/ui_actions.mdx | 36 + api_docs/ui_actions_enhanced.json | 4064 ++ api_docs/ui_actions_enhanced.mdx | 55 + api_docs/uptime.json | 141 + api_docs/uptime.mdx | 21 + api_docs/url_forwarding.json | 310 + api_docs/url_forwarding.mdx | 24 + api_docs/usage_collection.json | 519 + api_docs/usage_collection.mdx | 38 + api_docs/vis_type_timeseries.json | 90 + api_docs/vis_type_timeseries.mdx | 18 + api_docs/visualizations.json | 4045 ++ api_docs/visualizations.mdx | 44 + dev_docs/api_welcome.mdx | 77 +- .../build_api_declaration.ts | 3 +- .../build_arrow_fn_dec.ts | 3 +- .../build_api_declarations/build_class_dec.ts | 24 +- .../build_function_dec.ts | 5 +- .../build_interface_dec.ts | 31 +- .../build_type_literal_dec.ts | 3 +- .../build_variable_dec.ts | 16 +- .../src/api_docs/mdx/write_plugin_mdx_docs.ts | 17 +- .../src/plugin_a/public/classes.ts | 14 + .../src/plugin_a/public/const_vars.ts | 7 + .../__fixtures__/src/plugin_a/public/fns.ts | 5 + .../src/plugin_a/public/plugin.ts | 7 +- .../__fixtures__/src/plugin_a/public/types.ts | 3 + .../src/api_docs/tests/api_doc_suite.test.ts | 32 + .../api_docs/tests/snapshots/plugin_a.json | 188 +- .../src/api_docs/tests/snapshots/plugin_a.mdx | 10 + .../tests/snapshots/plugin_a_foo.json | 3 + .../api_docs/tests/snapshots/plugin_a_foo.mdx | 4 + packages/kbn-docs-utils/src/api_docs/utils.ts | 4 + 215 files changed, 284786 insertions(+), 111 deletions(-) create mode 100644 api_docs/actions.json create mode 100644 api_docs/actions.mdx create mode 100644 api_docs/advanced_settings.json create mode 100644 api_docs/advanced_settings.mdx create mode 100644 api_docs/alerts.json create mode 100644 api_docs/alerts.mdx create mode 100644 api_docs/apm.json create mode 100644 api_docs/apm.mdx create mode 100644 api_docs/apm_oss.json create mode 100644 api_docs/apm_oss.mdx create mode 100644 api_docs/banners.json create mode 100644 api_docs/banners.mdx create mode 100644 api_docs/beats_management.json create mode 100644 api_docs/beats_management.mdx create mode 100644 api_docs/bfetch.json create mode 100644 api_docs/bfetch.mdx create mode 100644 api_docs/canvas.json create mode 100644 api_docs/canvas.mdx create mode 100644 api_docs/case.json create mode 100644 api_docs/case.mdx create mode 100644 api_docs/charts.json create mode 100644 api_docs/charts.mdx create mode 100644 api_docs/cloud.json create mode 100644 api_docs/cloud.mdx create mode 100644 api_docs/console.json create mode 100644 api_docs/console.mdx create mode 100644 api_docs/core.json create mode 100644 api_docs/core.mdx create mode 100644 api_docs/core_application.json create mode 100644 api_docs/core_application.mdx create mode 100644 api_docs/core_chrome.json create mode 100644 api_docs/core_chrome.mdx create mode 100644 api_docs/core_http.json create mode 100644 api_docs/core_http.mdx create mode 100644 api_docs/core_saved_objects.json create mode 100644 api_docs/core_saved_objects.mdx create mode 100644 api_docs/dashboard.json create mode 100644 api_docs/dashboard.mdx create mode 100644 api_docs/dashboard_enhanced.json create mode 100644 api_docs/dashboard_enhanced.mdx create mode 100644 api_docs/dashboard_mode.json create mode 100644 api_docs/dashboard_mode.mdx create mode 100644 api_docs/data.json create mode 100644 api_docs/data.mdx create mode 100644 api_docs/data_autocomplete.json create mode 100644 api_docs/data_autocomplete.mdx create mode 100644 api_docs/data_enhanced.json create mode 100644 api_docs/data_enhanced.mdx create mode 100644 api_docs/data_field_formats.json create mode 100644 api_docs/data_field_formats.mdx create mode 100644 api_docs/data_index_patterns.json create mode 100644 api_docs/data_index_patterns.mdx create mode 100644 api_docs/data_query.json create mode 100644 api_docs/data_query.mdx create mode 100644 api_docs/data_search.json create mode 100644 api_docs/data_search.mdx create mode 100644 api_docs/data_ui.json create mode 100644 api_docs/data_ui.mdx create mode 100644 api_docs/dev_tools.json create mode 100644 api_docs/dev_tools.mdx create mode 100644 api_docs/discover.json create mode 100644 api_docs/discover.mdx create mode 100644 api_docs/discover_enhanced.json create mode 100644 api_docs/discover_enhanced.mdx create mode 100644 api_docs/embeddable.json create mode 100644 api_docs/embeddable.mdx create mode 100644 api_docs/embeddable_enhanced.json create mode 100644 api_docs/embeddable_enhanced.mdx create mode 100644 api_docs/encrypted_saved_objects.json create mode 100644 api_docs/encrypted_saved_objects.mdx create mode 100644 api_docs/enterprise_search.json create mode 100644 api_docs/enterprise_search.mdx create mode 100644 api_docs/es_ui_shared.json create mode 100644 api_docs/es_ui_shared.mdx create mode 100644 api_docs/event_log.json create mode 100644 api_docs/event_log.mdx create mode 100644 api_docs/expressions.json create mode 100644 api_docs/expressions.mdx create mode 100644 api_docs/features.json create mode 100644 api_docs/features.mdx create mode 100644 api_docs/file_upload.json create mode 100644 api_docs/file_upload.mdx create mode 100644 api_docs/fleet.json create mode 100644 api_docs/fleet.mdx create mode 100644 api_docs/global_search.json create mode 100644 api_docs/global_search.mdx create mode 100644 api_docs/home.json create mode 100644 api_docs/home.mdx create mode 100644 api_docs/index_lifecycle_management.json create mode 100644 api_docs/index_lifecycle_management.mdx create mode 100644 api_docs/index_management.json create mode 100644 api_docs/index_management.mdx create mode 100644 api_docs/index_pattern_field_editor.json create mode 100644 api_docs/index_pattern_field_editor.mdx create mode 100644 api_docs/index_pattern_management.json create mode 100644 api_docs/index_pattern_management.mdx create mode 100644 api_docs/infra.json create mode 100644 api_docs/infra.mdx create mode 100644 api_docs/ingest_pipelines.json create mode 100644 api_docs/ingest_pipelines.mdx create mode 100644 api_docs/inspector.json create mode 100644 api_docs/inspector.mdx create mode 100644 api_docs/kibana_legacy.json create mode 100644 api_docs/kibana_legacy.mdx create mode 100644 api_docs/kibana_react.json create mode 100644 api_docs/kibana_react.mdx create mode 100644 api_docs/kibana_utils.json create mode 100644 api_docs/kibana_utils.mdx create mode 100644 api_docs/lens.json create mode 100644 api_docs/lens.mdx create mode 100644 api_docs/license_management.json create mode 100644 api_docs/license_management.mdx create mode 100644 api_docs/licensing.json create mode 100644 api_docs/licensing.mdx create mode 100644 api_docs/lists.json create mode 100644 api_docs/lists.mdx create mode 100644 api_docs/management.json create mode 100644 api_docs/management.mdx create mode 100644 api_docs/maps.json create mode 100644 api_docs/maps.mdx create mode 100644 api_docs/maps_legacy.json create mode 100644 api_docs/maps_legacy.mdx create mode 100644 api_docs/ml.json create mode 100644 api_docs/ml.mdx create mode 100644 api_docs/monitoring.json create mode 100644 api_docs/monitoring.mdx create mode 100644 api_docs/navigation.json create mode 100644 api_docs/navigation.mdx create mode 100644 api_docs/newsfeed.json create mode 100644 api_docs/newsfeed.mdx create mode 100644 api_docs/observability.json create mode 100644 api_docs/observability.mdx create mode 100644 api_docs/osquery.json create mode 100644 api_docs/osquery.mdx create mode 100644 api_docs/presentation_util.json create mode 100644 api_docs/presentation_util.mdx create mode 100644 api_docs/remote_clusters.json create mode 100644 api_docs/remote_clusters.mdx create mode 100644 api_docs/reporting.json create mode 100644 api_docs/reporting.mdx create mode 100644 api_docs/rollup.json create mode 100644 api_docs/rollup.mdx create mode 100644 api_docs/runtime_fields.json create mode 100644 api_docs/runtime_fields.mdx create mode 100644 api_docs/saved_objects.json create mode 100644 api_docs/saved_objects.mdx create mode 100644 api_docs/saved_objects_management.json create mode 100644 api_docs/saved_objects_management.mdx create mode 100644 api_docs/saved_objects_tagging.json create mode 100644 api_docs/saved_objects_tagging.mdx create mode 100644 api_docs/saved_objects_tagging_oss.json create mode 100644 api_docs/saved_objects_tagging_oss.mdx create mode 100644 api_docs/security.json create mode 100644 api_docs/security.mdx create mode 100644 api_docs/security_oss.json create mode 100644 api_docs/security_oss.mdx create mode 100644 api_docs/security_solution.json create mode 100644 api_docs/security_solution.mdx create mode 100644 api_docs/share.json create mode 100644 api_docs/share.mdx create mode 100644 api_docs/snapshot_restore.json create mode 100644 api_docs/snapshot_restore.mdx create mode 100644 api_docs/spaces.json create mode 100644 api_docs/spaces.mdx create mode 100644 api_docs/spaces_oss.json create mode 100644 api_docs/spaces_oss.mdx create mode 100644 api_docs/stack_alerts.json create mode 100644 api_docs/stack_alerts.mdx create mode 100644 api_docs/task_manager.json create mode 100644 api_docs/task_manager.mdx create mode 100644 api_docs/telemetry.json create mode 100644 api_docs/telemetry.mdx create mode 100644 api_docs/telemetry_collection_manager.json create mode 100644 api_docs/telemetry_collection_manager.mdx create mode 100644 api_docs/telemetry_collection_xpack.json create mode 100644 api_docs/telemetry_collection_xpack.mdx create mode 100644 api_docs/telemetry_management_section.json create mode 100644 api_docs/telemetry_management_section.mdx create mode 100644 api_docs/triggers_actions_ui.json create mode 100644 api_docs/triggers_actions_ui.mdx create mode 100644 api_docs/ui_actions.json create mode 100644 api_docs/ui_actions.mdx create mode 100644 api_docs/ui_actions_enhanced.json create mode 100644 api_docs/ui_actions_enhanced.mdx create mode 100644 api_docs/uptime.json create mode 100644 api_docs/uptime.mdx create mode 100644 api_docs/url_forwarding.json create mode 100644 api_docs/url_forwarding.mdx create mode 100644 api_docs/usage_collection.json create mode 100644 api_docs/usage_collection.mdx create mode 100644 api_docs/vis_type_timeseries.json create mode 100644 api_docs/vis_type_timeseries.mdx create mode 100644 api_docs/visualizations.json create mode 100644 api_docs/visualizations.mdx diff --git a/.gitignore b/.gitignore index 1a4ffefd6d12f..fbe28b8f1e77c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .aws-config.json .signing-config.json -/api_docs .ackrc /.es /.chromium diff --git a/api_docs/actions.json b/api_docs/actions.json new file mode 100644 index 0000000000000..5d630dec25cbb --- /dev/null +++ b/api_docs/actions.json @@ -0,0 +1,1775 @@ +{ + "id": "actions", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.asSavedObjectExecutionSource", + "type": "Function", + "label": "asSavedObjectExecutionSource", + "signature": [ + "(source: Pick<", + "SavedObjectReference", + ", \"type\" | \"id\">) => ", + "SavedObjectExecutionSource" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "source", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + ", \"type\" | \"id\">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L30" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.asHttpRequestExecutionSource", + "type": "Function", + "label": "asHttpRequestExecutionSource", + "signature": [ + "(source: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + "HttpRequestExecutionSource" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "source", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.ActionsPlugin", + "type": "Interface", + "label": "ActionsPlugin", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionsPlugin.setup", + "type": "Object", + "label": "setup", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L56" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + } + ] + }, + { + "tags": [], + "id": "def-server.ActionsPlugin.start", + "type": "Object", + "label": "start", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L57" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionResult", + "type": "Interface", + "label": "ActionResult", + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionResult.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L70" + } + }, + { + "tags": [], + "id": "def-server.ActionResult.actionTypeId", + "type": "string", + "label": "actionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L71" + } + }, + { + "tags": [], + "id": "def-server.ActionResult.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L72" + } + }, + { + "tags": [], + "id": "def-server.ActionResult.config", + "type": "Uncategorized", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L73" + }, + "signature": [ + "Config | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ActionResult.isPreconfigured", + "type": "boolean", + "label": "isPreconfigured", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L74" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionTypeExecutorOptions", + "type": "Interface", + "label": "ActionTypeExecutorOptions", + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionTypeExecutorOptions", + "text": "ActionTypeExecutorOptions" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.actionId", + "type": "string", + "label": "actionId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L62" + } + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.services", + "type": "Object", + "label": "services", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L63" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.Services", + "text": "Services" + } + ] + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.config", + "type": "Uncategorized", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L64" + }, + "signature": [ + "Config" + ] + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.secrets", + "type": "Uncategorized", + "label": "secrets", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L65" + }, + "signature": [ + "Secrets" + ] + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L66" + }, + "signature": [ + "Params" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionType", + "type": "Interface", + "label": "ActionType", + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionType", + "text": "ActionType" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionType.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L108" + } + }, + { + "tags": [], + "id": "def-server.ActionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L109" + } + }, + { + "tags": [], + "id": "def-server.ActionType.maxAttempts", + "type": "number", + "label": "maxAttempts", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L110" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ActionType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L111" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] + }, + { + "tags": [], + "id": "def-server.ActionType.validate", + "type": "Object", + "label": "validate", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L112" + }, + "signature": [ + "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined" + ] + }, + { + "id": "def-server.ActionType.renderParameterTemplates", + "type": "Function", + "label": "renderParameterTemplates", + "signature": [ + "((params: Params, variables: Record) => Params) | undefined" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "params", + "isRequired": true, + "signature": [ + "Params" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117" + } + }, + { + "type": "Object", + "label": "variables", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117" + } + }, + { + "tags": [], + "id": "def-server.ActionType.executor", + "type": "Function", + "label": "executor", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L118" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ExecutorType", + "text": "ExecutorType" + }, + "" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L102" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PreConfiguredAction", + "type": "Interface", + "label": "PreConfiguredAction", + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PreConfiguredAction", + "text": "PreConfiguredAction" + }, + " extends ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.PreConfiguredAction.secrets", + "type": "Uncategorized", + "label": "secrets", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L81" + }, + "signature": [ + "Secrets" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionsApiRequestHandlerContext", + "type": "Interface", + "label": "ActionsApiRequestHandlerContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionsApiRequestHandlerContext.getActionsClient", + "type": "Function", + "label": "getActionsClient", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L47" + }, + "signature": [ + "() => ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionsClient", + "text": "ActionsClient" + } + ] + }, + { + "tags": [], + "id": "def-server.ActionsApiRequestHandlerContext.listTypes", + "type": "Function", + "label": "listTypes", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L48" + }, + "signature": [ + "() => ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionType", + "text": "ActionType" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L46" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.ActionsClient", + "type": "Type", + "label": "ActionsClient", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L15" + }, + "signature": [ + "{ get: ({ id }: { id: string; }) => Promise<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + ">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: CreateOptions) => Promise<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + ">>; update: ({ id, action }: UpdateOptions) => Promise<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + ">>; execute: ({ actionId, params, source, }: Pick<", + "ExecuteOptions", + ", \"source\" | \"params\" | \"actionId\">) => Promise<", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionTypeExecutorResult", + "text": "ActionTypeExecutorResult" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionsAuthorization", + "type": "Type", + "label": "ActionsAuthorization", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L16" + }, + "signature": [ + "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L143" + }, + "signature": [ + "\".email\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L99" + }, + "signature": [ + "{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L43" + }, + "signature": [ + "\".index\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L34" + }, + "signature": [ + "{ readonly documents: Record[]; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L121" + }, + "signature": [ + "\".pagerduty\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L50" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L42" + }, + "signature": [ + "\".server-log\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L25" + }, + "signature": [ + "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L54" + }, + "signature": [ + "\".slack\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L46" + }, + "signature": [ + "{ readonly message: string; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L76" + }, + "signature": [ + "\".webhook\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L71" + }, + "signature": [ + "{ readonly body?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ServiceNowITSMActionTypeId", + "type": "string", + "label": "ServiceNowITSMActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L47" + }, + "signature": [ + "\".servicenow\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ServiceNowSIRActionTypeId", + "type": "string", + "label": "ServiceNowSIRActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L48" + }, + "signature": [ + "\".servicenow-sir\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L35" + }, + "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[]; }>; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L52" + }, + "signature": [ + "\".jira\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L36" + }, + "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; }>; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L43" + }, + "signature": [ + "\".resilient\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L34" + }, + "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<{} & {}>; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L46" + }, + "signature": [ + "\".teams\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L40" + }, + "signature": [ + "{ readonly message: string; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.PluginSetupContract", + "type": "Interface", + "label": "PluginSetupContract", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.PluginSetupContract.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + " = Record, Secrets extends Record = Record, Params extends Record = Record, ExecutorResultData = void>(actionType: ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionType", + "text": "ActionType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "actionType", + "isRequired": true, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionType", + "text": "ActionType" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L94" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L88" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L87" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.PluginStartContract", + "type": "Interface", + "label": "PluginStartContract", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.PluginStartContract.isActionTypeEnabled", + "type": "Function", + "label": "isActionTypeEnabled", + "signature": [ + "(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99" + } + }, + { + "id": "def-server.PluginStartContract.isActionTypeEnabled.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.PluginStartContract.isActionTypeEnabled.options.notifyUsage", + "type": "boolean", + "label": "notifyUsage", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99" + } + }, + { + "id": "def-server.PluginStartContract.isActionExecutable", + "type": "Function", + "label": "isActionExecutable", + "signature": [ + "(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "actionId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L101" + } + }, + { + "type": "string", + "label": "actionTypeId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L102" + } + }, + { + "id": "def-server.PluginStartContract.isActionExecutable.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.PluginStartContract.isActionExecutable.options.notifyUsage", + "type": "boolean", + "label": "notifyUsage", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L103" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L103" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L100" + } + }, + { + "id": "def-server.PluginStartContract.getActionsClientWithRequest", + "type": "Function", + "label": "getActionsClientWithRequest", + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise>" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L105" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L105" + } + }, + { + "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest", + "type": "Function", + "label": "getActionsAuthorizationWithRequest", + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Pick<", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionsAuthorization", + "text": "ActionsAuthorization" + }, + ", \"ensureAuthorized\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L106" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L106" + } + }, + { + "tags": [], + "id": "def-server.PluginStartContract.preconfiguredActions", + "type": "Array", + "label": "preconfiguredActions", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L107" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PreConfiguredAction", + "text": "PreConfiguredAction" + }, + ", Record>[]" + ] + }, + { + "id": "def-server.PluginStartContract.renderActionParameterTemplates", + "type": "Function", + "label": "renderActionParameterTemplates", + "signature": [ + " = Record>(actionTypeId: string, params: Params, variables: Record) => Params" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "actionTypeId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L109" + } + }, + { + "type": "Uncategorized", + "label": "params", + "isRequired": true, + "signature": [ + "Params" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L110" + } + }, + { + "type": "Object", + "label": "variables", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L111" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L108" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/server/plugin.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L98" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.isActionTypeExecutorResult", + "type": "Function", + "label": "isActionTypeExecutorResult", + "signature": [ + "(result: unknown) => boolean" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "result", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L43" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L42" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.ActionType", + "type": "Interface", + "label": "ActionType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ActionType.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.ActionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.ActionType.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.ActionType.enabledInConfig", + "type": "boolean", + "label": "enabledInConfig", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.ActionType.enabledInLicense", + "type": "boolean", + "label": "enabledInLicense", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.ActionType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L16" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ActionResult", + "type": "Interface", + "label": "ActionResult", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ActionResult.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.ActionResult.actionTypeId", + "type": "string", + "label": "actionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.ActionResult.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.ActionResult.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L25" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.ActionResult.isPreconfigured", + "type": "boolean", + "label": "isPreconfigured", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L26" + } + } + ], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ActionTypeExecutorResult", + "type": "Interface", + "label": "ActionTypeExecutorResult", + "signature": [ + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionTypeExecutorResult", + "text": "ActionTypeExecutorResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.actionId", + "type": "string", + "label": "actionId", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L34" + } + }, + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L35" + }, + "signature": [ + "\"error\" | \"ok\"" + ] + }, + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L36" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.serviceMessage", + "type": "string", + "label": "serviceMessage", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L37" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.data", + "type": "Uncategorized", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L38" + }, + "signature": [ + "Data | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ActionTypeExecutorResult.retry", + "type": "CompoundType", + "label": "retry", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L39" + }, + "signature": [ + "boolean | Date | null | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L33" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.BASE_ACTION_API_PATH", + "type": "string", + "label": "BASE_ACTION_API_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/index.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/index.ts#L10" + }, + "signature": [ + "\"/api/actions\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx new file mode 100644 index 0000000000000..a5b27c67eaca1 --- /dev/null +++ b/api_docs/actions.mdx @@ -0,0 +1,41 @@ +--- +id: kibActionsPluginApi +slug: /kibana-dev-docs/actionsPluginApi +title: actions +image: https://source.unsplash.com/400x175/?github +summary: API docs for the actions plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import actionsObj from './actions.json'; + +## Server + +### Setup + + +### Start + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json new file mode 100644 index 0000000000000..452eb623f06c2 --- /dev/null +++ b/api_docs/advanced_settings.json @@ -0,0 +1,301 @@ +{ + "id": "advancedSettings", + "client": { + "classes": [ + { + "id": "def-public.ComponentRegistry", + "type": "Class", + "tags": [], + "label": "ComponentRegistry", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ComponentRegistry.componentType", + "type": "Object", + "label": "componentType", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L28" + }, + "signature": [ + "{ [key: string]: Id; }" + ] + }, + { + "id": "def-public.ComponentRegistry.defaultRegistry", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title", + "type": "Function", + "label": "advanced_settings_page_title", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L30" + }, + "signature": [ + "() => JSX.Element" + ] + }, + { + "tags": [], + "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle", + "type": "Function", + "label": "advanced_settings_page_subtitle", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L31" + }, + "signature": [ + "() => null" + ] + }, + { + "tags": [], + "id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer", + "type": "Function", + "label": "advanced_settings_page_footer", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L32" + }, + "signature": [ + "() => null" + ] + } + ], + "description": [], + "label": "defaultRegistry", + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L29" + } + }, + { + "id": "def-public.ComponentRegistry.registry", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "registry", + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L35" + } + }, + { + "id": "def-public.ComponentRegistry.setup", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ComponentRegistry.setup.componentType", + "type": "Object", + "label": "componentType", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L72" + }, + "signature": [ + "{ [key: string]: Id; }" + ] + }, + { + "tags": [], + "id": "def-public.ComponentRegistry.setup.register", + "type": "Function", + "label": "register", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L73" + }, + "signature": [ + "(id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void" + ] + } + ], + "description": [], + "label": "setup", + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L71" + } + }, + { + "id": "def-public.ComponentRegistry.start", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ComponentRegistry.start.componentType", + "type": "Object", + "label": "componentType", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L77" + }, + "signature": [ + "{ [key: string]: Id; }" + ] + }, + { + "tags": [], + "id": "def-public.ComponentRegistry.start.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L78" + }, + "signature": [ + "(id: Id) => React.ComponentType | undefined>" + ] + } + ], + "description": [], + "label": "start", + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L76" + } + } + ], + "source": { + "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L27" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "tags": [], + "id": "def-public.LazyField", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/index.ts#L20" + }, + "signature": [ + "React.LazyExoticComponent" + ], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.AdvancedSettingsSetup", + "type": "Interface", + "label": "AdvancedSettingsSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AdvancedSettingsSetup.component", + "type": "Object", + "label": "component", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L16" + }, + "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": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L15" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.AdvancedSettingsStart", + "type": "Interface", + "label": "AdvancedSettingsStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AdvancedSettingsStart.component", + "type": "Object", + "label": "component", + "description": [], + "source": { + "path": "src/plugins/advanced_settings/public/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L19" + }, + "signature": [ + "{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType | undefined>; }" + ] + } + ], + "source": { + "path": "src/plugins/advanced_settings/public/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L18" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx new file mode 100644 index 0000000000000..5b0e69c14f58b --- /dev/null +++ b/api_docs/advanced_settings.mdx @@ -0,0 +1,27 @@ +--- +id: kibAdvancedSettingsPluginApi +slug: /kibana-dev-docs/advancedSettingsPluginApi +title: advancedSettings +image: https://source.unsplash.com/400x175/?github +summary: API docs for the advancedSettings plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import advancedSettingsObj from './advanced_settings.json'; + +## Client + +### Setup + + +### Start + + +### Functions + + +### Classes + + diff --git a/api_docs/alerts.json b/api_docs/alerts.json new file mode 100644 index 0000000000000..371fc2b6472f5 --- /dev/null +++ b/api_docs/alerts.json @@ -0,0 +1,3419 @@ +{ + "id": "alerts", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.PluginSetupContract", + "type": "Interface", + "label": "PluginSetupContract", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PluginSetupContract.registerNavigation", + "type": "Function", + "label": "registerNavigation", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/public/plugin.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L15" + }, + "signature": [ + "(consumer: string, alertType: string, handler: ", + { + "pluginId": "alerts", + "scope": "public", + "docId": "kibAlertsPluginApi", + "section": "def-public.AlertNavigationHandler", + "text": "AlertNavigationHandler" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-public.PluginSetupContract.registerDefaultNavigation", + "type": "Function", + "label": "registerDefaultNavigation", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/public/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L20" + }, + "signature": [ + "(consumer: string, handler: ", + { + "pluginId": "alerts", + "scope": "public", + "docId": "kibAlertsPluginApi", + "section": "def-public.AlertNavigationHandler", + "text": "AlertNavigationHandler" + }, + ") => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/public/plugin.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L14" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.PluginStartContract", + "type": "Interface", + "label": "PluginStartContract", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PluginStartContract.getNavigation", + "type": "Function", + "label": "getNavigation", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/public/plugin.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L23" + }, + "signature": [ + "(alertId: string) => Promise<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertUrlNavigation", + "text": "AlertUrlNavigation" + }, + " | ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertStateNavigation", + "text": "AlertStateNavigation" + }, + " | undefined>" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/public/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L22" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.parseDuration", + "type": "Function", + "label": "parseDuration", + "signature": [ + "(duration: string) => number" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.ActionVariable", + "type": "Interface", + "label": "ActionVariable", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionVariable.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L106" + } + }, + { + "tags": [], + "id": "def-server.ActionVariable.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L107" + } + }, + { + "tags": [], + "id": "def-server.ActionVariable.useWithTripleBracesInTemplates", + "type": "CompoundType", + "label": "useWithTripleBracesInTemplates", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L108" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L105" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AlertType", + "type": "Interface", + "label": "AlertType", + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertType", + "text": "AlertType" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AlertType.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L132" + } + }, + { + "tags": [], + "id": "def-server.AlertType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L133" + } + }, + { + "tags": [], + "id": "def-server.AlertType.validate", + "type": "Object", + "label": "validate", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L134" + }, + "signature": [ + "{ params?: ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertTypeParamsValidator", + "text": "AlertTypeParamsValidator" + }, + " | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.actionGroups", + "type": "Array", + "label": "actionGroups", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L137" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.defaultActionGroupId", + "type": "Uncategorized", + "label": "defaultActionGroupId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L138" + }, + "signature": [ + "ActionGroupIds" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.recoveryActionGroup", + "type": "Object", + "label": "recoveryActionGroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L139" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.executor", + "type": "Function", + "label": "executor", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L140" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.ExecutorType", + "text": "ExecutorType" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.producer", + "type": "string", + "label": "producer", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L151" + } + }, + { + "tags": [], + "id": "def-server.AlertType.actionVariables", + "type": "Object", + "label": "actionVariables", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L152" + }, + "signature": [ + "{ context?: ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; state?: ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; params?: ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L157" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L124" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionGroup", + "type": "Interface", + "label": "ActionGroup", + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ActionGroup.id", + "type": "Uncategorized", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L26" + }, + "signature": [ + "ActionGroupIds" + ] + }, + { + "tags": [], + "id": "def-server.ActionGroup.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L27" + } + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AlertingPlugin", + "type": "Interface", + "label": "AlertingPlugin", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AlertingPlugin.setup", + "type": "Object", + "label": "setup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L231" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + } + ] + }, + { + "tags": [], + "id": "def-server.AlertingPlugin.start", + "type": "Object", + "label": "start", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L232" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L230" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AlertExecutorOptions", + "type": "Interface", + "label": "AlertExecutorOptions", + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertExecutorOptions", + "text": "AlertExecutorOptions" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AlertExecutorOptions.alertId", + "type": "string", + "label": "alertId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L91" + } + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.startedAt", + "type": "Object", + "label": "startedAt", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L92" + }, + "signature": [ + "Date" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.previousStartedAt", + "type": "CompoundType", + "label": "previousStartedAt", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L93" + }, + "signature": [ + "Date | null" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.services", + "type": "Object", + "label": "services", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L94" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertServices", + "text": "AlertServices" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L95" + }, + "signature": [ + "Params" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.state", + "type": "Uncategorized", + "label": "state", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L96" + }, + "signature": [ + "State" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.spaceId", + "type": "string", + "label": "spaceId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L97" + } + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L98" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L99" + } + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L100" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.createdBy", + "type": "CompoundType", + "label": "createdBy", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L101" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-server.AlertExecutorOptions.updatedBy", + "type": "CompoundType", + "label": "updatedBy", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L102" + }, + "signature": [ + "string | null" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L84" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AlertServices", + "type": "Interface", + "label": "AlertServices", + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertServices", + "text": "AlertServices" + }, + " extends ", + "Services" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AlertServices.alertInstanceFactory", + "type": "Function", + "label": "alertInstanceFactory", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L79" + }, + "signature": [ + "(id: string) => Pick<", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertInstance", + "text": "AlertInstance" + }, + ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AlertingApiRequestHandlerContext", + "type": "Interface", + "label": "AlertingApiRequestHandlerContext", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AlertingApiRequestHandlerContext.getAlertsClient", + "type": "Function", + "label": "getAlertsClient", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L47" + }, + "signature": [ + "() => ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertsClient", + "text": "AlertsClient" + } + ] + }, + { + "tags": [], + "id": "def-server.AlertingApiRequestHandlerContext.listTypes", + "type": "Function", + "label": "listTypes", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L48" + }, + "signature": [ + "() => Set<", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.RegistryAlertType", + "text": "RegistryAlertType" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.AlertingApiRequestHandlerContext.getFrameworkHealth", + "type": "Function", + "label": "getFrameworkHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L49" + }, + "signature": [ + "() => Promise<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + }, + ">" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginSetupContract", + "type": "Interface", + "label": "PluginSetupContract", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.PluginSetupContract.registerType", + "type": "Function", + "label": "registerType", + "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: ", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertType", + "text": "AlertType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "alertType", + "isRequired": true, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertType", + "text": "AlertType" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L112" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L104" + } + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L103" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginStartContract", + "type": "Interface", + "label": "PluginStartContract", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.PluginStartContract.listTypes", + "type": "Function", + "label": "listTypes", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L124" + }, + "signature": [ + "() => Set<", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.RegistryAlertType", + "text": "RegistryAlertType" + }, + ">" + ] + }, + { + "id": "def-server.PluginStartContract.getAlertsClientWithRequest", + "type": "Function", + "label": "getAlertsClientWithRequest", + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Pick<", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.AlertsClient", + "text": "AlertsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L125" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L125" + } + }, + { + "tags": [], + "id": "def-server.PluginStartContract.getFrameworkHealth", + "type": "Function", + "label": "getFrameworkHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L126" + }, + "signature": [ + "() => Promise<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + }, + ">" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/plugin.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L123" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FindResult", + "type": "Interface", + "label": "FindResult", + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.FindResult", + "text": "FindResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FindResult.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L131" + } + }, + { + "tags": [], + "id": "def-server.FindResult.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L132" + } + }, + { + "tags": [], + "id": "def-server.FindResult.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L133" + } + }, + { + "tags": [], + "id": "def-server.FindResult.data", + "type": "Array", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L134" + }, + "signature": [ + "Pick<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/server/alerts_client/alerts_client.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L130" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.AlertsClient", + "type": "Type", + "label": "AlertsClient", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/index.ts#L15" + }, + "signature": [ + "{ get: ({ id, }: { id: string; }) => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ", + "CreateOptions", + ") => Promise<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ">; find: ({ options: { fields, ...options }, }?: { options?: ", + "FindOptions", + " | undefined; }) => Promise<", + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.FindResult", + "text": "FindResult" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ActionGroupIdsOf", + "type": "Type", + "label": "ActionGroupIdsOf", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L30" + }, + "signature": [ + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AlertActionParams", + "type": "Type", + "label": "AlertActionParams", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L40" + }, + "signature": [ + "SavedObjectAttributes" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AlertTypeState", + "type": "Type", + "label": "AlertTypeState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L11" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AlertTypeParams", + "type": "Type", + "label": "AlertTypeParams", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L12" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PartialAlert", + "type": "Type", + "label": "PartialAlert", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/types.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L190" + }, + "signature": [ + "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AlertInstanceState", + "type": "Type", + "label": "AlertInstanceState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L25" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AlertInstanceContext", + "type": "Type", + "label": "AlertInstanceContext", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L28" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PublicAlertInstance", + "type": "Type", + "label": "PublicAlertInstance", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/server/alert_instance/alert_instance.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alert_instance/alert_instance.ts#L30" + }, + "signature": [ + "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.getBuiltinActionGroups", + "type": "Function", + "label": "getBuiltinActionGroups", + "signature": [ + "(customRecoveryGroup: ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined) => [", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ReservedActionGroups", + "text": "ReservedActionGroups" + }, + ">]" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "customRecoveryGroup", + "isRequired": false, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L31" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isActionGroupDisabledForActionTypeId", + "type": "Function", + "label": "isActionGroupDisabledForActionTypeId", + "signature": [ + "(actionGroup: string, actionTypeId: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "actionGroup", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/disabled_action_groups.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L19" + } + }, + { + "type": "string", + "label": "actionTypeId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/disabled_action_groups.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/disabled_action_groups.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.validateNotifyWhenType", + "type": "Function", + "label": "validateNotifyWhenType", + "signature": [ + "(notifyWhen: string) => string | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "notifyWhen", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.parseDuration", + "type": "Function", + "label": "parseDuration", + "signature": [ + "(duration: string) => number" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getDurationNumberInItsUnit", + "type": "Function", + "label": "getDurationNumberInItsUnit", + "signature": [ + "(duration: string) => number" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L30" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getDurationUnitValue", + "type": "Function", + "label": "getDurationUnitValue", + "signature": [ + "(duration: string) => string" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-common.validateDurationSchema", + "type": "Function", + "label": "validateDurationSchema", + "signature": [ + "(duration: string) => string | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L39" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerts/common/parse_duration.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L39" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.AlertingFrameworkHealth", + "type": "Interface", + "label": "AlertingFrameworkHealth", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", + "type": "boolean", + "label": "isSufficientlySecure", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", + "type": "boolean", + "label": "hasPermanentEncryptionKey", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L23" + } + }, + { + "tags": [], + "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", + "type": "Object", + "label": "alertingFrameworkHeath", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L24" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IntervalSchedule", + "type": "Interface", + "label": "IntervalSchedule", + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" + }, + " extends ", + "SavedObjectAttributes" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IntervalSchedule.interval", + "type": "string", + "label": "interval", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L15" + } + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertExecutionStatus", + "type": "Interface", + "label": "AlertExecutionStatus", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertExecutionStatus.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L32" + }, + "signature": [ + "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" + ] + }, + { + "tags": [], + "id": "def-common.AlertExecutionStatus.lastExecutionDate", + "type": "Object", + "label": "lastExecutionDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L33" + }, + "signature": [ + "Date" + ] + }, + { + "tags": [], + "id": "def-common.AlertExecutionStatus.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L34" + }, + "signature": [ + "{ reason: ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertExecutionStatusErrorReasons", + "text": "AlertExecutionStatusErrorReasons" + }, + "; message: string; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertAction", + "type": "Interface", + "label": "AlertAction", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertAction.group", + "type": "string", + "label": "group", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L44" + } + }, + { + "tags": [], + "id": "def-common.AlertAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L45" + } + }, + { + "tags": [], + "id": "def-common.AlertAction.actionTypeId", + "type": "string", + "label": "actionTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L46" + } + }, + { + "tags": [], + "id": "def-common.AlertAction.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L47" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertAggregations", + "type": "Interface", + "label": "AlertAggregations", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertAggregations.alertExecutionStatus", + "type": "Object", + "label": "alertExecutionStatus", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L51" + }, + "signature": [ + "{ [status: string]: number; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L50" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Alert", + "type": "Interface", + "label": "Alert", + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Alert.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L55" + } + }, + { + "tags": [], + "id": "def-common.Alert.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.Alert.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.Alert.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L58" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Alert.alertTypeId", + "type": "string", + "label": "alertTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L59" + } + }, + { + "tags": [], + "id": "def-common.Alert.consumer", + "type": "string", + "label": "consumer", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L60" + } + }, + { + "tags": [], + "id": "def-common.Alert.schedule", + "type": "Object", + "label": "schedule", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L61" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" + } + ] + }, + { + "tags": [], + "id": "def-common.Alert.actions", + "type": "Array", + "label": "actions", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L62" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertAction", + "text": "AlertAction" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.Alert.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L63" + }, + "signature": [ + "Params" + ] + }, + { + "tags": [], + "id": "def-common.Alert.scheduledTaskId", + "type": "string", + "label": "scheduledTaskId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L64" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Alert.createdBy", + "type": "CompoundType", + "label": "createdBy", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L65" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.updatedBy", + "type": "CompoundType", + "label": "updatedBy", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L66" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.createdAt", + "type": "Object", + "label": "createdAt", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L67" + }, + "signature": [ + "Date" + ] + }, + { + "tags": [], + "id": "def-common.Alert.updatedAt", + "type": "Object", + "label": "updatedAt", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L68" + }, + "signature": [ + "Date" + ] + }, + { + "tags": [], + "id": "def-common.Alert.apiKey", + "type": "CompoundType", + "label": "apiKey", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L69" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.apiKeyOwner", + "type": "CompoundType", + "label": "apiKeyOwner", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L70" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.throttle", + "type": "CompoundType", + "label": "throttle", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L71" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.notifyWhen", + "type": "CompoundType", + "label": "notifyWhen", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L72" + }, + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" + ] + }, + { + "tags": [], + "id": "def-common.Alert.muteAll", + "type": "boolean", + "label": "muteAll", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L73" + } + }, + { + "tags": [], + "id": "def-common.Alert.mutedInstanceIds", + "type": "Array", + "label": "mutedInstanceIds", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L74" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Alert.executionStatus", + "type": "Object", + "label": "executionStatus", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L75" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertExecutionStatus", + "text": "AlertExecutionStatus" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertsHealth", + "type": "Interface", + "label": "AlertsHealth", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertsHealth.decryptionHealth", + "type": "Object", + "label": "decryptionHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L87" + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + }, + { + "tags": [], + "id": "def-common.AlertsHealth.executionHealth", + "type": "Object", + "label": "executionHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L91" + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + }, + { + "tags": [], + "id": "def-common.AlertsHealth.readHealth", + "type": "Object", + "label": "readHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L95" + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L86" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertType", + "type": "Interface", + "label": "AlertType", + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertType", + "text": "AlertType" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertType.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.AlertType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.AlertType.actionGroups", + "type": "Array", + "label": "actionGroups", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L17" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.AlertType.recoveryActionGroup", + "type": "Object", + "label": "recoveryActionGroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L18" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.AlertType.actionVariables", + "type": "Array", + "label": "actionVariables", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L19" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.AlertType.defaultActionGroupId", + "type": "Uncategorized", + "label": "defaultActionGroupId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L20" + }, + "signature": [ + "ActionGroupIds" + ] + }, + { + "tags": [], + "id": "def-common.AlertType.producer", + "type": "string", + "label": "producer", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.AlertType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L22" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ActionGroup", + "type": "Interface", + "label": "ActionGroup", + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ActionGroup.id", + "type": "Uncategorized", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L26" + }, + "signature": [ + "ActionGroupIds" + ] + }, + { + "tags": [], + "id": "def-common.ActionGroup.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L27" + } + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertUrlNavigation", + "type": "Interface", + "label": "AlertUrlNavigation", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertUrlNavigation.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_navigation.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L11" + } + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_navigation.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertStateNavigation", + "type": "Interface", + "label": "AlertStateNavigation", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertStateNavigation.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_navigation.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L14" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_navigation.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceSummary", + "type": "Interface", + "label": "AlertInstanceSummary", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertInstanceSummary.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.tags", + "type": "Array", + "label": "tags", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L14" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.alertTypeId", + "type": "string", + "label": "alertTypeId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.consumer", + "type": "string", + "label": "consumer", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.muteAll", + "type": "boolean", + "label": "muteAll", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.throttle", + "type": "CompoundType", + "label": "throttle", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L18" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L19" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.statusStartDate", + "type": "string", + "label": "statusStartDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.statusEndDate", + "type": "string", + "label": "statusEndDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L22" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertStatusValues", + "text": "AlertStatusValues" + } + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.lastRun", + "type": "string", + "label": "lastRun", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L23" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.errorMessages", + "type": "Array", + "label": "errorMessages", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L24" + }, + "signature": [ + "{ date: string; message: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.instances", + "type": "Object", + "label": "instances", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L25" + }, + "signature": [ + "Record" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceStatus", + "type": "Interface", + "label": "AlertInstanceStatus", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertInstanceStatus.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L29" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertInstanceStatusValues", + "text": "AlertInstanceStatusValues" + } + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceStatus.muted", + "type": "boolean", + "label": "muted", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceStatus.actionGroupId", + "type": "string", + "label": "actionGroupId", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L31" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceStatus.actionSubgroup", + "type": "string", + "label": "actionSubgroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceStatus.activeStartDate", + "type": "string", + "label": "activeStartDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L33" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L28" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.AlertExecutionStatusErrorReasons", + "type": "Enum", + "label": "AlertExecutionStatusErrorReasons", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.HealthStatus", + "type": "Enum", + "label": "HealthStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L80" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-common.BASE_ALERT_API_PATH", + "type": "string", + "label": "BASE_ALERT_API_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L27" + }, + "signature": [ + "\"/api/alerts\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ALERTS_FEATURE_ID", + "type": "string", + "label": "ALERTS_FEATURE_ID", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/index.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L28" + }, + "signature": [ + "\"alerts\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertTypeState", + "type": "Type", + "label": "AlertTypeState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L11" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertTypeParams", + "type": "Type", + "label": "AlertTypeParams", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L12" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertExecutionStatuses", + "type": "Type", + "label": "AlertExecutionStatuses", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L21" + }, + "signature": [ + "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertActionParams", + "type": "Type", + "label": "AlertActionParams", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L40" + }, + "signature": [ + "SavedObjectAttributes" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertActionParam", + "type": "Type", + "label": "AlertActionParam", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L41" + }, + "signature": [ + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SanitizedAlert", + "type": "Type", + "label": "SanitizedAlert", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L78" + }, + "signature": [ + "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; muteAll: boolean; tags: string[]; 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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ActionGroupIdsOf", + "type": "Type", + "label": "ActionGroupIdsOf", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L30" + }, + "signature": [ + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceMeta", + "type": "Type", + "label": "AlertInstanceMeta", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L22" + }, + "signature": [ + "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceState", + "type": "Type", + "label": "AlertInstanceState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L25" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceContext", + "type": "Type", + "label": "AlertInstanceContext", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L28" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RawAlertInstance", + "type": "Type", + "label": "RawAlertInstance", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L34" + }, + "signature": [ + "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertTaskState", + "type": "Type", + "label": "AlertTaskState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_task_instance.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L18" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertTaskParams", + "type": "Type", + "label": "AlertTaskParams", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_task_instance.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L28" + }, + "signature": [ + "{ alertId: string; } & { spaceId?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertNavigation", + "type": "Type", + "label": "AlertNavigation", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_navigation.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L16" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertUrlNavigation", + "text": "AlertUrlNavigation" + }, + " | ", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.AlertStateNavigation", + "text": "AlertStateNavigation" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertStatusValues", + "type": "Type", + "label": "AlertStatusValues", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L8" + }, + "signature": [ + "\"OK\" | \"Active\" | \"Error\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertInstanceStatusValues", + "type": "Type", + "label": "AlertInstanceStatusValues", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance_summary.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L9" + }, + "signature": [ + "\"OK\" | \"Active\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DefaultActionGroupId", + "type": "Type", + "label": "DefaultActionGroupId", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L11" + }, + "signature": [ + "\"default\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RecoveredActionGroupId", + "type": "Type", + "label": "RecoveredActionGroupId", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L13" + }, + "signature": [ + "\"recovered\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ReservedActionGroups", + "type": "Type", + "label": "ReservedActionGroups", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L21" + }, + "signature": [ + "RecoveryActionGroupId | \"recovered\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.WithoutReservedActionGroups", + "type": "Type", + "label": "WithoutReservedActionGroups", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L25" + }, + "signature": [ + "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AlertNotifyWhenType", + "type": "Type", + "label": "AlertNotifyWhenType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_notify_when_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L13" + }, + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.AlertExecutionStatusValues", + "type": "Object", + "label": "AlertExecutionStatusValues", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L20" + }, + "signature": [ + "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.rawAlertInstance", + "type": "Object", + "label": "rawAlertInstance", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_instance.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L30" + }, + "signature": [ + "PartialC", + "<{ state: ", + "RecordC", + "<", + "StringC", + ", ", + "UnknownC", + ">; meta: ", + "PartialC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.alertStateSchema", + "type": "Object", + "label": "alertStateSchema", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_task_instance.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L12" + }, + "signature": [ + "PartialC", + "<{ alertTypeState: ", + "RecordC", + "<", + "StringC", + ", ", + "UnknownC", + ">; alertInstances: ", + "RecordC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.alertParamsSchema", + "type": "Object", + "label": "alertParamsSchema", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/alert_task_instance.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L20" + }, + "signature": [ + "IntersectionC", + "<[", + "TypeC", + "<{ alertId: ", + "StringC", + "; }>, ", + "PartialC", + "<{ spaceId: ", + "StringC" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.RecoveredActionGroup", + "type": "Object", + "label": "RecoveredActionGroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/builtin_action_groups.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L14" + }, + "signature": [ + "Readonly<", + { + "pluginId": "alerts", + "scope": "common", + "docId": "kibAlertsPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "<\"recovered\">>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DisabledActionTypeIdsForActionGroup", + "type": "Object", + "label": "DisabledActionTypeIdsForActionGroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerts/common/disabled_action_groups.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L14" + }, + "signature": [ + "Map" + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/alerts.mdx b/api_docs/alerts.mdx new file mode 100644 index 0000000000000..7dffe418963fd --- /dev/null +++ b/api_docs/alerts.mdx @@ -0,0 +1,49 @@ +--- +id: kibAlertsPluginApi +slug: /kibana-dev-docs/alertsPluginApi +title: alerts +image: https://source.unsplash.com/400x175/?github +summary: API docs for the alerts plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerts'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import alertsObj from './alerts.json'; + +## Client + +### Setup + + +### Start + + +## Server + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/apm.json b/api_docs/apm.json new file mode 100644 index 0000000000000..316b49cb562be --- /dev/null +++ b/api_docs/apm.json @@ -0,0 +1,808 @@ +{ + "id": "apm", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.ConfigSchema", + "type": "Interface", + "label": "ConfigSchema", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ConfigSchema.serviceMapEnabled", + "type": "boolean", + "label": "serviceMapEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/apm/public/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.ConfigSchema.profilingEnabled", + "type": "boolean", + "label": "profilingEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/apm/public/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.ConfigSchema.ui", + "type": "Object", + "label": "ui", + "description": [], + "source": { + "path": "x-pack/plugins/apm/public/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L17" + }, + "signature": [ + "{ enabled: boolean; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/apm/public/index.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L14" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "start": { + "id": "def-public.ApmPluginStart", + "type": "Type", + "label": "ApmPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/public/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/plugin.ts#L45" + }, + "signature": [ + "void" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "id": "def-server.APMPlugin", + "type": "Class", + "tags": [], + "label": "APMPlugin", + "description": [], + "signature": [ + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMPlugin", + "text": "APMPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMPluginSetup", + "text": "APMPluginSetup" + }, + ", void, object, object>" + ], + "children": [ + { + "id": "def-server.APMPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61" + } + }, + { + "id": "def-server.APMPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: { apmOss: ", + { + "pluginId": "apmOss", + "scope": "server", + "docId": "kibApmOssPluginApi", + "section": "def-server.APMOSSPluginSetup", + "text": "APMOSSPluginSetup" + }, + "; home: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.HomeServerPluginSetup", + "text": "HomeServerPluginSetup" + }, + "; licensing: ", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginSetup", + "text": "LicensingPluginSetup" + }, + "; cloud?: ", + { + "pluginId": "cloud", + "scope": "server", + "docId": "kibCloudPluginApi", + "section": "def-server.CloudSetup", + "text": "CloudSetup" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L66" + } + }, + { + "id": "def-server.APMPlugin.setup.plugins", + "type": "Object", + "label": "plugins", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.apmOss", + "type": "Object", + "label": "apmOss", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L68" + }, + "signature": [ + { + "pluginId": "apmOss", + "scope": "server", + "docId": "kibApmOssPluginApi", + "section": "def-server.APMOSSPluginSetup", + "text": "APMOSSPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.home", + "type": "Object", + "label": "home", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L69" + }, + "signature": [ + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.HomeServerPluginSetup", + "text": "HomeServerPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.licensing", + "type": "Object", + "label": "licensing", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L70" + }, + "signature": [ + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginSetup", + "text": "LicensingPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.cloud", + "type": "Object", + "label": "cloud", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L71" + }, + "signature": [ + { + "pluginId": "cloud", + "scope": "server", + "docId": "kibCloudPluginApi", + "section": "def-server.CloudSetup", + "text": "CloudSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.usageCollection", + "type": "Object", + "label": "usageCollection", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L72" + }, + "signature": [ + "Pick<", + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.CollectorSet", + "text": "CollectorSet" + }, + ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.taskManager", + "type": "CompoundType", + "label": "taskManager", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L73" + }, + "signature": [ + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerSetupContract", + "text": "TaskManagerSetupContract" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.alerts", + "type": "Object", + "label": "alerts", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L74" + }, + "signature": [ + { + "pluginId": "alerts", + "scope": "server", + "docId": "kibAlertsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.actions", + "type": "Object", + "label": "actions", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L75" + }, + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.observability", + "type": "Object", + "label": "observability", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L76" + }, + "signature": [ + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityPluginSetup", + "text": "ObservabilityPluginSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.features", + "type": "Object", + "label": "features", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L77" + }, + "signature": [ + { + "pluginId": "features", + "scope": "server", + "docId": "kibFeaturesPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + } + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.security", + "type": "Object", + "label": "security", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L78" + }, + "signature": [ + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.SecurityPluginSetup", + "text": "SecurityPluginSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.APMPlugin.setup.plugins.ml", + "type": "CompoundType", + "label": "ml", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L79" + }, + "signature": [ + { + "pluginId": "ml", + "scope": "server", + "docId": "kibMlPluginApi", + "section": "def-server.SharedServices", + "text": "SharedServices" + }, + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L65" + } + }, + { + "id": "def-server.APMPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196" + } + }, + { + "id": "def-server.APMPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L215" + } + } + ], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L58" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-server.mergeConfigs", + "type": "Function", + "label": "mergeConfigs", + "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", + "; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>) => { '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; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "apmOssConfig", + "isRequired": true, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L60" + } + }, + { + "type": "Object", + "label": "apmConfig", + "isRequired": true, + "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: ", + { + "pluginId": "apm", + "scope": "common", + "docId": "kibApmPluginApi", + "section": "def-common.SearchAggregatedTransactionSetting", + "text": "SearchAggregatedTransactionSetting" + }, + "; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L61" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L59" + }, + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [ + { + "id": "def-server.ProcessorEvent", + "type": "Enum", + "label": "ProcessorEvent", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/common/processor_event.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/common/processor_event.ts#L8" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-server.APMXPackConfig", + "type": "Type", + "label": "APMXPackConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L55" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.APMConfig", + "type": "Type", + "label": "APMConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/index.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L56" + }, + "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; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.APMPluginSetup", + "type": "Interface", + "label": "APMPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.APMPluginSetup.config$", + "type": "Object", + "label": "config$", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L49" + }, + "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': ", + { + "pluginId": "apm", + "scope": "common", + "docId": "kibApmPluginApi", + "section": "def-common.SearchAggregatedTransactionSetting", + "text": "SearchAggregatedTransactionSetting" + }, + "; 'xpack.apm.metricsInterval': number; }>" + ] + }, + { + "tags": [], + "id": "def-server.APMPluginSetup.getApmIndices", + "type": "Function", + "label": "getApmIndices", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L50" + }, + "signature": [ + "() => Promise<", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.ApmIndicesConfig", + "text": "ApmIndicesConfig" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.APMPluginSetup.createApmEventClient", + "type": "Function", + "label": "createApmEventClient", + "description": [], + "source": { + "path": "x-pack/plugins/apm/server/plugin.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L51" + }, + "signature": [ + "(params: { debug?: boolean | undefined; request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; context: ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.ApmPluginRequestHandlerContext", + "text": "ApmPluginRequestHandlerContext" + }, + "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<", + "ESSearchResponse", + " + +### Interfaces + + +## Server + +### Setup + + +### Functions + + +### Classes + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json new file mode 100644 index 0000000000000..ee79a93d14dd4 --- /dev/null +++ b/api_docs/apm_oss.json @@ -0,0 +1,635 @@ +{ + "id": "apmOss", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.APM_STATIC_INDEX_PATTERN_ID", + "type": "string", + "label": "APM_STATIC_INDEX_PATTERN_ID", + "description": [], + "source": { + "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9" + }, + "signature": [ + "\"apm_static_index_pattern_id\"" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.ApmOssPluginSetup", + "type": "Interface", + "label": "ApmOssPluginSetup", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "src/plugins/apm_oss/public/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L10" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.ApmOssPluginStart", + "type": "Interface", + "label": "ApmOssPluginStart", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "src/plugins/apm_oss/public/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L13" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.createNodeAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createDjangoAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createFlaskAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createRailsAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createRackAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createJsAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 393, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createGoAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 492, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 492, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createJavaAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 585, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 585, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createDotNetAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 631, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 631, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.createPhpAgentInstructions", + "type": "Function", + "children": [ + { + "type": "string", + "label": "apmServerUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 705, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705" + } + }, + { + "type": "string", + "label": "secretToken", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", + "lineNumber": 705, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "id": "def-server.APMOSSConfig", + "type": "Type", + "label": "APMOSSConfig", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/index.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/index.ts#L32" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.APM_STATIC_INDEX_PATTERN_ID", + "type": "string", + "label": "APM_STATIC_INDEX_PATTERN_ID", + "description": [], + "source": { + "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9" + }, + "signature": [ + "\"apm_static_index_pattern_id\"" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.APMOSSPluginSetup", + "type": "Interface", + "label": "APMOSSPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.APMOSSPluginSetup.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/plugin.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L48" + }, + "signature": [ + "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" + ] + }, + { + "tags": [], + "id": "def-server.APMOSSPluginSetup.config$", + "type": "Object", + "label": "config$", + "description": [], + "source": { + "path": "src/plugins/apm_oss/server/plugin.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L49" + }, + "signature": [ + "Observable", + ">" + ] + }, + { + "id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider", + "type": "Function", + "label": "getRegisteredTutorialProvider", + "signature": [ + "() => ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.TutorialProvider", + "text": "TutorialProvider" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/apm_oss/server/plugin.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L50" + } + } + ], + "source": { + "path": "src/plugins/apm_oss/server/plugin.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L47" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/apm_oss.mdx b/api_docs/apm_oss.mdx new file mode 100644 index 0000000000000..c4facc4e390b6 --- /dev/null +++ b/api_docs/apm_oss.mdx @@ -0,0 +1,35 @@ +--- +id: kibApmOssPluginApi +slug: /kibana-dev-docs/apmOssPluginApi +title: apmOss +image: https://source.unsplash.com/400x175/?github +summary: API docs for the apmOss plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss'] +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 apmOssObj from './apm_oss.json'; + +## Client + +### Setup + + +### Start + + +### Consts, variables and types + + +## Server + +### Setup + + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/banners.json b/api_docs/banners.json new file mode 100644 index 0000000000000..981c17a7de679 --- /dev/null +++ b/api_docs/banners.json @@ -0,0 +1,165 @@ +{ + "id": "banners", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-common.BannerInfoResponse", + "type": "Interface", + "label": "BannerInfoResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BannerInfoResponse.allowed", + "type": "boolean", + "label": "allowed", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L9" + } + }, + { + "tags": [], + "id": "def-common.BannerInfoResponse.banner", + "type": "Object", + "label": "banner", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L10" + }, + "signature": [ + { + "pluginId": "banners", + "scope": "common", + "docId": "kibBannersPluginApi", + "section": "def-common.BannerConfiguration", + "text": "BannerConfiguration" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BannerConfiguration", + "type": "Interface", + "label": "BannerConfiguration", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BannerConfiguration.placement", + "type": "CompoundType", + "label": "placement", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L16" + }, + "signature": [ + { + "pluginId": "banners", + "scope": "common", + "docId": "kibBannersPluginApi", + "section": "def-common.BannerPlacement", + "text": "BannerPlacement" + } + ] + }, + { + "tags": [], + "id": "def-common.BannerConfiguration.textContent", + "type": "string", + "label": "textContent", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.BannerConfiguration.textColor", + "type": "string", + "label": "textColor", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.BannerConfiguration.backgroundColor", + "type": "string", + "label": "backgroundColor", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L19" + } + } + ], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L15" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-common.BannerPlacement", + "type": "Type", + "label": "BannerPlacement", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L13" + }, + "signature": [ + "\"disabled\" | \"header\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx new file mode 100644 index 0000000000000..e6b648e38cdc3 --- /dev/null +++ b/api_docs/banners.mdx @@ -0,0 +1,21 @@ +--- +id: kibBannersPluginApi +slug: /kibana-dev-docs/bannersPluginApi +title: banners +image: https://source.unsplash.com/400x175/?github +summary: API docs for the banners plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import bannersObj from './banners.json'; + +## Common + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/beats_management.json b/api_docs/beats_management.json new file mode 100644 index 0000000000000..f0c995b47d594 --- /dev/null +++ b/api_docs/beats_management.json @@ -0,0 +1,69 @@ +{ + "id": "beatsManagement", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "id": "def-common.BeatsManagementConfigType", + "type": "Type", + "label": "BeatsManagementConfigType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/beats_management/common/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L23" + }, + "signature": [ + "{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.beatsManagementConfigSchema", + "type": "Object", + "label": "beatsManagementConfigSchema", + "description": [], + "source": { + "path": "x-pack/plugins/beats_management/common/index.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L12" + }, + "signature": [ + "ObjectType", + "<{ enabled: ", + "Type", + "; defaultUserRoles: ", + "Type", + "; encryptionKey: ", + "Type", + "; enrollmentTokensTtlInSeconds: ", + "Type" + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/beats_management.mdx b/api_docs/beats_management.mdx new file mode 100644 index 0000000000000..9d712c102a1a2 --- /dev/null +++ b/api_docs/beats_management.mdx @@ -0,0 +1,21 @@ +--- +id: kibBeatsManagementPluginApi +slug: /kibana-dev-docs/beatsManagementPluginApi +title: beatsManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the beatsManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'beatsManagement'] +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 beatsManagementObj from './beats_management.json'; + +## Common + +### Objects + + +### Consts, variables and types + + diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json new file mode 100644 index 0000000000000..cf0bfbf4dd916 --- /dev/null +++ b/api_docs/bfetch.json @@ -0,0 +1,1209 @@ +{ + "id": "bfetch", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.split", + "type": "Function", + "children": [ + { + "type": "string", + "label": "delimiter", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/public/streaming/split.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "id": "def-public.BatchedFunc", + "type": "Type", + "label": "BatchedFunc", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/bfetch/public/batching/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/batching/types.ts#L17" + }, + "signature": [ + "(payload: Payload, signal: AbortSignal | undefined) => Promise" + ], + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "id": "def-public.BfetchPublicContract", + "type": "Interface", + "label": "BfetchPublicContract", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.BfetchPublicContract.fetchStreaming", + "type": "Function", + "label": "fetchStreaming", + "description": [], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L25" + }, + "signature": [ + "(params: ", + { + "pluginId": "bfetch", + "scope": "public", + "docId": "kibBfetchPluginApi", + "section": "def-public.FetchStreamingParams", + "text": "FetchStreamingParams" + }, + ") => { xhr: XMLHttpRequest; stream: ", + "Observable", + "; }" + ] + }, + { + "tags": [], + "id": "def-public.BfetchPublicContract.batchedFunction", + "type": "Function", + "label": "batchedFunction", + "description": [], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L26" + }, + "signature": [ + "(params: ", + { + "pluginId": "bfetch", + "scope": "public", + "docId": "kibBfetchPluginApi", + "section": "def-public.StreamingBatchedFunctionParams", + "text": "StreamingBatchedFunctionParams" + }, + ") => ", + { + "pluginId": "bfetch", + "scope": "public", + "docId": "kibBfetchPluginApi", + "section": "def-public.BatchedFunc", + "text": "BatchedFunc" + }, + "" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/public/plugin.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L24" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.BatchProcessingRouteParams", + "type": "Interface", + "label": "BatchProcessingRouteParams", + "signature": [ + { + "pluginId": "bfetch", + "scope": "server", + "docId": "kibBfetchPluginApi", + "section": "def-server.BatchProcessingRouteParams", + "text": "BatchProcessingRouteParams" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.BatchProcessingRouteParams.onBatchItem", + "type": "Function", + "label": "onBatchItem", + "description": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L40" + }, + "signature": [ + "(data: BatchItemData) => Promise" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L39" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.StreamingRequestHandler", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/types.ts#L18" + }, + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + "Observable", + " | Promise<", + "Observable", + ">" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.BfetchServerSetup", + "type": "Interface", + "label": "BfetchServerSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.BfetchServerSetup.addBatchProcessingRoute", + "type": "Function", + "label": "addBatchProcessingRoute", + "description": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L45" + }, + "signature": [ + "(path: string, handler: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "bfetch", + "scope": "server", + "docId": "kibBfetchPluginApi", + "section": "def-server.BatchProcessingRouteParams", + "text": "BatchProcessingRouteParams" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-server.BfetchServerSetup.addStreamingResponseRoute", + "type": "Function", + "label": "addStreamingResponseRoute", + "description": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L49" + }, + "signature": [ + "(path: string, params: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.StreamingResponseHandler", + "text": "StreamingResponseHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.BfetchServerSetup.createStreamingRequestHandler", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L81" + }, + "signature": [ + "(streamHandler: ", + { + "pluginId": "bfetch", + "scope": "server", + "docId": "kibBfetchPluginApi", + "section": "def-server.StreamingRequestHandler", + "text": "StreamingRequestHandler" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + } + ] + } + ], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L44" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.BfetchServerStart", + "type": "Interface", + "label": "BfetchServerStart", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "src/plugins/bfetch/server/plugin.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L94" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "id": "def-common.ItemBuffer", + "type": "Class", + "tags": [], + "label": "ItemBuffer", + "description": [ + "\nA simple buffer that collects items. Can be cleared or flushed; and can\nautomatically flush when specified number of items is reached." + ], + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBuffer", + "text": "ItemBuffer" + }, + "" + ], + "children": [ + { + "id": "def-common.ItemBuffer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBufferParams", + "text": "ItemBufferParams" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32" + } + }, + { + "id": "def-common.ItemBuffer.length", + "type": "number", + "label": "length", + "tags": [], + "description": [ + "\nGet current buffer size." + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L37" + } + }, + { + "id": "def-common.ItemBuffer.write", + "type": "Function", + "label": "write", + "signature": [ + "(item: Item) => void" + ], + "description": [ + "\nAdd item to the buffer." + ], + "children": [ + { + "type": "Uncategorized", + "label": "item", + "isRequired": true, + "signature": [ + "Item" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44" + } + }, + { + "id": "def-common.ItemBuffer.clear", + "type": "Function", + "label": "clear", + "signature": [ + "() => void" + ], + "description": [ + "\nRemove all items from the buffer." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L58" + } + }, + { + "id": "def-common.ItemBuffer.flush", + "type": "Function", + "label": "flush", + "signature": [ + "() => void" + ], + "description": [ + "\nCall `.onflush` method and clear buffer." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L65" + } + } + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TimedItemBuffer", + "type": "Class", + "tags": [], + "label": "TimedItemBuffer", + "description": [], + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.TimedItemBuffer", + "text": "TimedItemBuffer" + }, + " extends ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBuffer", + "text": "ItemBuffer" + }, + "" + ], + "children": [ + { + "id": "def-common.TimedItemBuffer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.TimedItemBufferParams", + "text": "TimedItemBufferParams" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22" + } + }, + { + "id": "def-common.TimedItemBuffer.write", + "type": "Function", + "label": "write", + "signature": [ + "(item: Item) => void" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "item", + "isRequired": true, + "signature": [ + "Item" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26" + } + }, + { + "id": "def-common.TimedItemBuffer.clear", + "type": "Function", + "label": "clear", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L34" + } + }, + { + "id": "def-common.TimedItemBuffer.flush", + "type": "Function", + "label": "flush", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L39" + } + } + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L19" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.normalizeError", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "err", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/util/normalize_error.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11" + } + } + ], + "signature": [ + "(err: any) => E" + ], + "description": [], + "label": "normalizeError", + "source": { + "path": "src/plugins/bfetch/common/util/normalize_error.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.removeLeadingSlash", + "type": "Function", + "children": [ + { + "type": "string", + "label": "text", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9" + } + } + ], + "signature": [ + "(text: string) => string" + ], + "description": [], + "label": "removeLeadingSlash", + "source": { + "path": "src/plugins/bfetch/common/util/remove_leading_slash.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createBatchedFunction", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L22" + } + } + ], + "signature": [ + "(params: ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.BatchedFunctionParams", + "text": "BatchedFunctionParams" + }, + ") => [Func, ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.TimedItemBuffer", + "text": "TimedItemBuffer" + }, + "]" + ], + "description": [], + "label": "createBatchedFunction", + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L21" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.StreamingResponseHandler", + "type": "Interface", + "label": "StreamingResponseHandler", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.StreamingResponseHandler", + "text": "StreamingResponseHandler" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.StreamingResponseHandler.getResponseStream", + "type": "Function", + "label": "getResponseStream", + "signature": [ + "(payload: Payload) => ", + "Observable", + "" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "payload", + "isRequired": true, + "signature": [ + "Payload" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12" + } + } + ], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ItemBufferParams", + "type": "Interface", + "label": "ItemBufferParams", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBufferParams", + "text": "ItemBufferParams" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ItemBufferParams.flushOnMaxItems", + "type": "number", + "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." + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L15" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ItemBufferParams.onFlush", + "type": "Function", + "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." + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L22" + }, + "signature": [ + "(items: Item[]) => void" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TimedItemBufferParams", + "type": "Interface", + "label": "TimedItemBufferParams", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.TimedItemBufferParams", + "text": "TimedItemBufferParams" + }, + " extends ", + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBufferParams", + "text": "ItemBufferParams" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TimedItemBufferParams.maxItemAge", + "type": "number", + "label": "maxItemAge", + "description": [ + "\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds." + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L16" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BatchedFunctionParams", + "type": "Interface", + "label": "BatchedFunctionParams", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.BatchedFunctionParams", + "text": "BatchedFunctionParams" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BatchedFunctionParams.onCall", + "type": "Function", + "label": "onCall", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L15" + }, + "signature": [ + "(...args: Parameters) => [ReturnType, BatchEntry]" + ] + }, + { + "tags": [], + "id": "def-common.BatchedFunctionParams.onBatch", + "type": "Function", + "label": "onBatch", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L16" + }, + "signature": [ + "(items: BatchEntry[]) => void" + ] + }, + { + "tags": [], + "id": "def-common.BatchedFunctionParams.flushOnMaxItems", + "type": "number", + "label": "flushOnMaxItems", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L17" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BatchedFunctionParams.maxItemAge", + "type": "number", + "label": "maxItemAge", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L18" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ErrorLike", + "type": "Interface", + "label": "ErrorLike", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ErrorLike.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L10" + } + } + ], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BatchRequestData", + "type": "Interface", + "label": "BatchRequestData", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.BatchRequestData", + "text": "BatchRequestData" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BatchRequestData.batch", + "type": "Array", + "label": "batch", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L14" + }, + "signature": [ + "Item[]" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BatchResponseItem", + "type": "Interface", + "label": "BatchResponseItem", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.BatchResponseItem", + "text": "BatchResponseItem" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BatchResponseItem.id", + "type": "number", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.BatchResponseItem.result", + "type": "Uncategorized", + "label": "result", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L19" + }, + "signature": [ + "Result | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BatchResponseItem.error", + "type": "Uncategorized", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L20" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L17" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx new file mode 100644 index 0000000000000..0e9a9e79dbea6 --- /dev/null +++ b/api_docs/bfetch.mdx @@ -0,0 +1,49 @@ +--- +id: kibBfetchPluginApi +slug: /kibana-dev-docs/bfetchPluginApi +title: bfetch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the bfetch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import bfetchObj from './bfetch.json'; + +## Client + +### Start + + +### Functions + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Functions + + +### Classes + + +### Interfaces + + diff --git a/api_docs/canvas.json b/api_docs/canvas.json new file mode 100644 index 0000000000000..650423400045a --- /dev/null +++ b/api_docs/canvas.json @@ -0,0 +1,120 @@ +{ + "id": "canvas", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.WithKibanaProps", + "type": "Interface", + "label": "WithKibanaProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.WithKibanaProps.kibana", + "type": "Object", + "label": "kibana", + "description": [], + "source": { + "path": "x-pack/plugins/canvas/public/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L16" + }, + "signature": [ + "{ services: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + " & ", + { + "pluginId": "canvas", + "scope": "public", + "docId": "kibCanvasPluginApi", + "section": "def-public.CanvasStartDeps", + "text": "CanvasStartDeps" + }, + " & { canvas: ", + { + "pluginId": "canvas", + "scope": "public", + "docId": "kibCanvasPluginApi", + "section": "def-public.CanvasServices", + "text": "CanvasServices" + }, + "; }; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/canvas/public/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L15" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.CanvasSetup", + "type": "Type", + "label": "CanvasSetup", + "tags": [ + "public" + ], + "description": [ + "\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces." + ], + "source": { + "path": "x-pack/plugins/canvas/public/plugin.tsx", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L63" + }, + "signature": [ + "CanvasApi" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.CanvasStart", + "type": "Type", + "label": "CanvasStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/canvas/public/plugin.tsx", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L64" + }, + "signature": [ + "void" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx new file mode 100644 index 0000000000000..4555d2bf9fef3 --- /dev/null +++ b/api_docs/canvas.mdx @@ -0,0 +1,24 @@ +--- +id: kibCanvasPluginApi +slug: /kibana-dev-docs/canvasPluginApi +title: canvas +image: https://source.unsplash.com/400x175/?github +summary: API docs for the canvas plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import canvasObj from './canvas.json'; + +## Client + +### Setup + + +### Start + + +### Interfaces + + diff --git a/api_docs/case.json b/api_docs/case.json new file mode 100644 index 0000000000000..c6b124325c83d --- /dev/null +++ b/api_docs/case.json @@ -0,0 +1,65 @@ +{ + "id": "case", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.CaseRequestContext", + "type": "Interface", + "label": "CaseRequestContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.CaseRequestContext.getCaseClient", + "type": "Function", + "label": "getCaseClient", + "description": [], + "source": { + "path": "x-pack/plugins/case/server/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L14" + }, + "signature": [ + "() => ", + { + "pluginId": "case", + "scope": "server", + "docId": "kibCasePluginApi", + "section": "def-server.CaseClient", + "text": "CaseClient" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/case/server/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L13" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/case.mdx b/api_docs/case.mdx new file mode 100644 index 0000000000000..00a5d3c04060b --- /dev/null +++ b/api_docs/case.mdx @@ -0,0 +1,18 @@ +--- +id: kibCasePluginApi +slug: /kibana-dev-docs/casePluginApi +title: case +image: https://source.unsplash.com/400x175/?github +summary: API docs for the case plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'case'] +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 caseObj from './case.json'; + +## Server + +### Interfaces + + diff --git a/api_docs/charts.json b/api_docs/charts.json new file mode 100644 index 0000000000000..d1ba272be29f1 --- /dev/null +++ b/api_docs/charts.json @@ -0,0 +1,2639 @@ +{ + "id": "charts", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.getHeatmapColors", + "type": "Function", + "label": "getHeatmapColors", + "signature": [ + "(value: any, colorSchemaName: string) => string" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" + } + }, + { + "type": "string", + "label": "colorSchemaName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-public.createColorPalette", + "type": "Function", + "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." + ], + "children": [ + { + "type": "number", + "label": "num", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/colors/color_palette.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/charts/public/static/colors/color_palette.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LegendToggle", + "type": "Function", + "label": "LegendToggle", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/legend_toggle.tsx#L51" + }, + "signature": [ + "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ColorPicker", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ onChange, color: selectedColor, id, label }", + "isRequired": true, + "signature": [ + "ColorPickerProps" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83" + } + } + ], + "signature": [ + "({ onChange, color: selectedColor, id, label }: ColorPickerProps) => JSX.Element" + ], + "description": [], + "label": "ColorPicker", + "source": { + "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.CurrentTime", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{ isDarkMode, domainEnd }", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/current_time.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.Endzones", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n isDarkMode,\n domainStart,\n domainEnd,\n interval,\n domainMin,\n domainMax,\n hideTooltips = true,\n isFullBin = false,\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getAdjustedInterval", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "xValues", + "isRequired": true, + "signature": [ + "number[]" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L121" + } + }, + { + "type": "number", + "label": "esValue", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L122" + } + }, + { + "type": "CompoundType", + "label": "esUnit", + "isRequired": true, + "signature": [ + "moment.unitOfTime.Base" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L123" + } + }, + { + "type": "string", + "label": "timeZone", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L124" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L120" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.renderEndzoneTooltip", + "type": "Function", + "children": [ + { + "type": "number", + "label": "xInterval", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L160" + } + }, + { + "type": "number", + "label": "domainStart", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L161" + } + }, + { + "type": "number", + "label": "domainEnd", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L162" + } + }, + { + "type": "Function", + "label": "formatter", + "isRequired": false, + "signature": [ + "((v: any) => string) | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L163" + } + }, + { + "type": "boolean", + "label": "renderValue", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L164" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L159" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getFilterFromChartClickEventFn", + "type": "Function", + "children": [ + { + "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": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L172" + } + }, + { + "type": "CompoundType", + "label": "xAccessor", + "isRequired": true, + "signature": [ + "string | number | ", + "AccessorFn" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L173" + } + }, + { + "type": "Object", + "label": "splitSeriesAccessorFnMap", + "isRequired": false, + "signature": [ + "Map | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L174" + } + }, + { + "type": "CompoundType", + "label": "splitChartAccessor", + "isRequired": false, + "signature": [ + "string | number | ", + "AccessorFn", + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L175" + } + }, + { + "type": "boolean", + "label": "negate", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L176" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L171" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getFilterFromSeriesFn", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220" + } + } + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => ({ splitAccessors, ...rest }: ", + "XYChartSeriesIdentifier", + ", splitSeriesAccessorFnMap?: Map | undefined, splitChartAccessor?: string | number | ", + "AccessorFn", + " | undefined, negate?: boolean) => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ClickTriggerEvent", + "text": "ClickTriggerEvent" + } + ], + "description": [ + "\nHelper function to get filter action event from series" + ], + "label": "getFilterFromSeriesFn", + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getBrushFromChartBrushEventFn", + "type": "Function", + "children": [ + { + "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": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L255" + } + }, + { + "type": "CompoundType", + "label": "xAccessor", + "isRequired": true, + "signature": [ + "string | number | ", + "AccessorFn" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L256" + } + } + ], + "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" + } + ], + "description": [ + "\nHelper function to transform `@elastic/charts` brush event into brush action event" + ], + "label": "getBrushFromChartBrushEventFn", + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L254" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.PaletteOutput", + "type": "Interface", + "label": "PaletteOutput", + "signature": [ + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PaletteOutput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29" + }, + "signature": [ + "\"palette\"" + ] + }, + { + "tags": [], + "id": "def-public.PaletteOutput.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30" + } + }, + { + "tags": [], + "id": "def-public.PaletteOutput.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31" + }, + "signature": [ + "T | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CustomPaletteArguments", + "type": "Interface", + "label": "CustomPaletteArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CustomPaletteArguments.color", + "type": "Array", + "label": "color", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CustomPaletteArguments.gradient", + "type": "boolean", + "label": "gradient", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.CustomPaletteArguments.reverse", + "type": "CompoundType", + "label": "reverse", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CustomPaletteState", + "type": "Interface", + "label": "CustomPaletteState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CustomPaletteState.colors", + "type": "Array", + "label": "colors", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.CustomPaletteState.gradient", + "type": "boolean", + "label": "gradient", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SystemPaletteArguments", + "type": "Interface", + "label": "SystemPaletteArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SystemPaletteArguments.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25" + } + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ColorSchema", + "type": "Interface", + "label": "ColorSchema", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ColorSchema.value", + "type": "Enum", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L21" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + } + ] + }, + { + "tags": [], + "id": "def-public.ColorSchema.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L22" + } + } + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RawColorSchema", + "type": "Interface", + "label": "RawColorSchema", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RawColorSchema.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L26" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + } + ] + }, + { + "tags": [], + "id": "def-public.RawColorSchema.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.RawColorSchema.value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L28" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ColorMap", + "type": "Interface", + "label": "ColorMap", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.ColorMap.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L32" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ColorSchemaParams", + "type": "Interface", + "label": "ColorSchemaParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ColorSchemaParams.colorSchema", + "type": "Enum", + "label": "colorSchema", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L13" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + } + ] + }, + { + "tags": [], + "id": "def-public.ColorSchemaParams.invertColors", + "type": "boolean", + "label": "invertColors", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L14" + } + } + ], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Labels", + "type": "Interface", + "label": "Labels", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Labels.color", + "type": "string", + "label": "color", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Labels.filter", + "type": "CompoundType", + "label": "filter", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L19" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Labels.overwriteColor", + "type": "CompoundType", + "label": "overwriteColor", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Labels.rotate", + "type": "number", + "label": "rotate", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L21" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Labels.show", + "type": "CompoundType", + "label": "show", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L22" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Labels.truncate", + "type": "CompoundType", + "label": "truncate", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L23" + }, + "signature": [ + "number | null | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Style", + "type": "Interface", + "label": "Style", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Style.bgFill", + "type": "string", + "label": "bgFill", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.Style.bgColor", + "type": "boolean", + "label": "bgColor", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.Style.labelColor", + "type": "boolean", + "label": "labelColor", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L29" + } + }, + { + "tags": [], + "id": "def-public.Style.subText", + "type": "string", + "label": "subText", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L30" + } + }, + { + "tags": [], + "id": "def-public.Style.fontSize", + "type": "number", + "label": "fontSize", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L31" + } + } + ], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ClickTriggerEvent", + "type": "Interface", + "label": "ClickTriggerEvent", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ClickTriggerEvent.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L22" + }, + "signature": [ + "\"filterBucket\"" + ] + }, + { + "tags": [], + "id": "def-public.ClickTriggerEvent.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L23" + }, + "signature": [ + "{ data: { table: Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "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": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.BrushTriggerEvent", + "type": "Interface", + "label": "BrushTriggerEvent", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.BrushTriggerEvent.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L27" + }, + "signature": [ + "\"brush\"" + ] + }, + { + "tags": [], + "id": "def-public.BrushTriggerEvent.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L28" + }, + "signature": [ + "{ table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; column: number; range: number[]; timeFieldName?: string | undefined; }" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SeriesLayer", + "type": "Interface", + "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": [], + "children": [ + { + "tags": [], + "id": "def-public.SeriesLayer.name", + "type": "string", + "label": "name", + "description": [ + "\nName of the series (can be used for lookup-based coloring)" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.SeriesLayer.rankAtDepth", + "type": "number", + "label": "rankAtDepth", + "description": [ + "\nRank of the series compared to siblings with the same ancestor" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L23" + } + }, + { + "tags": [], + "id": "def-public.SeriesLayer.totalSeriesAtDepth", + "type": "number", + "label": "totalSeriesAtDepth", + "description": [ + "\nTotal number of series with the same ancestor" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L27" + } + } + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChartColorConfiguration", + "type": "Interface", + "label": "ChartColorConfiguration", + "description": [ + "\nInformation about the structure of a chart to determine the color of a series within it." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ChartColorConfiguration.totalSeries", + "type": "number", + "label": "totalSeries", + "description": [ + "\nOverall number of series in the current chart" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L37" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChartColorConfiguration.maxDepth", + "type": "number", + "label": "maxDepth", + "description": [ + "\nMax nesting depth of the series tree" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L41" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChartColorConfiguration.behindText", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L46" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChartColorConfiguration.syncColors", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L51" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PaletteDefinition", + "type": "Interface", + "label": "PaletteDefinition", + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.PaletteDefinition", + "text": "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PaletteDefinition.id", + "type": "string", + "label": "id", + "description": [ + "\nUnique id of the palette (this will be persisted along with the visualization state)" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L67" + } + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.title", + "type": "string", + "label": "title", + "description": [ + "\nUser facing title (should be i18n-ized)" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L71" + } + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.internal", + "type": "CompoundType", + "label": "internal", + "description": [ + "\nFlag indicating whether users should be able to pick this palette manually." + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L75" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.toExpression", + "type": "Function", + "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" + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L81" + }, + "signature": [ + "(state?: T | undefined) => ", + "Ast" + ] + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.renderEditor", + "type": "Function", + "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." + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L88" + }, + "signature": [ + "((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.getColor", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L97" + }, + "signature": [ + "(series: ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.SeriesLayer", + "text": "SeriesLayer" + }, + "[], chartConfiguration?: ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ChartColorConfiguration", + "text": "ChartColorConfiguration" + }, + " | undefined, state?: T | undefined) => string | null" + ] + }, + { + "tags": [], + "id": "def-public.PaletteDefinition.getColors", + "type": "Function", + "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." + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L106" + }, + "signature": [ + "(size: number, state?: T | undefined) => string[]" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L63" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PaletteRegistry", + "type": "Interface", + "label": "PaletteRegistry", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PaletteRegistry.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L110" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.PaletteDefinition", + "text": "PaletteDefinition" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.PaletteRegistry.getAll", + "type": "Function", + "label": "getAll", + "description": [], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L111" + }, + "signature": [ + "() => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.PaletteDefinition", + "text": "PaletteDefinition" + }, + "[]" + ] + } + ], + "source": { + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L109" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.ColorSchemas", + "type": "Enum", + "label": "ColorSchemas", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L11" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-public.paletteIds", + "type": "Array", + "label": "paletteIds", + "description": [], + "source": { + "path": "src/plugins/charts/common/constants.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.colorSchemas", + "type": "Array", + "label": "colorSchemas", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 3160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L3160" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchema", + "text": "ColorSchema" + }, + "[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.truncatedColorSchemas", + "type": "Array", + "label": "truncatedColorSchemas", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L26" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchema", + "text": "ColorSchema" + }, + "[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.seedColors", + "type": "Array", + "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." + ], + "source": { + "path": "src/plugins/charts/public/static/colors/seed_colors.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/seed_colors.ts#L14" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ColorMode", + "type": "Type", + "label": "ColorMode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L17" + }, + "signature": [ + "\"Background\" | \"Labels\" | \"None\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.LabelRotation", + "type": "Type", + "label": "LabelRotation", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L24" + }, + "signature": [ + "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.defaultCountLabel", + "type": "string", + "label": "defaultCountLabel", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L26" + }, + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.vislibColorMaps", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-public.vislibColorMaps.[ColorSchemas.Blues]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L38" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".Blues" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L39" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Blues].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L42" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [ + "// Sequential" + ], + "label": "[ColorSchemas.Blues]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L37" + } + }, + { + "id": "def-public.vislibColorMaps.[ColorSchemas.Greens]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 558, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L558" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".Greens" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 559, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L559" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greens].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 562, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L562" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [], + "label": "[ColorSchemas.Greens]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 557, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L557" + } + }, + { + "id": "def-public.vislibColorMaps.[ColorSchemas.Greys]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1078, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1078" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".Greys" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1079, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1079" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Greys].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1082, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1082" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [], + "label": "[ColorSchemas.Greys]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1077, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1077" + } + }, + { + "id": "def-public.vislibColorMaps.[ColorSchemas.Reds]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1598, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1598" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".Reds" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1599, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1599" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.Reds].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1602" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [], + "label": "[ColorSchemas.Reds]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 1597, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1597" + } + }, + { + "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2118" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".YellowToRed" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2119" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.YellowToRed].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2122" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [], + "label": "[ColorSchemas.YellowToRed]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2117" + } + }, + { + "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed]", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2639, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2639" + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + }, + ".GreenToRed" + ] + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2640, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2640" + } + }, + { + "tags": [], + "id": "def-public.vislibColorMaps.[ColorSchemas.GreenToRed].value", + "type": "Array", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2643, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2643" + }, + "signature": [ + "[number, number[]][]" + ] + } + ], + "description": [], + "label": "[ColorSchemas.GreenToRed]", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 2638, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2638" + } + } + ], + "description": [], + "label": "vislibColorMaps", + "source": { + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.truncatedColorMaps", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "truncatedColorMaps", + "source": { + "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L11" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ColorMode", + "type": "Object", + "label": "ColorMode", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L12" + }, + "signature": [ + "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.LabelRotation", + "type": "Object", + "label": "LabelRotation", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L19" + }, + "signature": [ + "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" + ], + "initialIsOpen": false + } + ], + "start": { + "id": "def-public.ChartsPluginStart", + "type": "Type", + "label": "ChartsPluginStart", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/plugin.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/plugin.ts#L31" + }, + "signature": [ + "ChartsPluginSetup" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.palette", + "type": "Function", + "label": "palette", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"palette\", null, ", + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.CustomPaletteArguments", + "text": "CustomPaletteArguments" + }, + ", ", + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "<", + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.CustomPaletteState", + "text": "CustomPaletteState" + }, + ">, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.systemPalette", + "type": "Function", + "label": "systemPalette", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + "<\"system_palette\", null, ", + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.SystemPaletteArguments", + "text": "SystemPaletteArguments" + }, + ", ", + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L119" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.CustomPaletteArguments", + "type": "Interface", + "label": "CustomPaletteArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CustomPaletteArguments.color", + "type": "Array", + "label": "color", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CustomPaletteArguments.gradient", + "type": "boolean", + "label": "gradient", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.CustomPaletteArguments.reverse", + "type": "CompoundType", + "label": "reverse", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CustomPaletteState", + "type": "Interface", + "label": "CustomPaletteState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CustomPaletteState.colors", + "type": "Array", + "label": "colors", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.CustomPaletteState.gradient", + "type": "boolean", + "label": "gradient", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SystemPaletteArguments", + "type": "Interface", + "label": "SystemPaletteArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SystemPaletteArguments.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25" + } + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PaletteOutput", + "type": "Interface", + "label": "PaletteOutput", + "signature": [ + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PaletteOutput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29" + }, + "signature": [ + "\"palette\"" + ] + }, + { + "tags": [], + "id": "def-common.PaletteOutput.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.PaletteOutput.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31" + }, + "signature": [ + "T | undefined" + ] + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.COLOR_MAPPING_SETTING", + "type": "string", + "label": "COLOR_MAPPING_SETTING", + "description": [], + "source": { + "path": "src/plugins/charts/common/index.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/index.ts#L9" + }, + "signature": [ + "\"visualization:colorMapping\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.defaultCustomColors", + "type": "Array", + "label": "defaultCustomColors", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L33" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.paletteIds", + "type": "Array", + "label": "paletteIds", + "description": [], + "source": { + "path": "src/plugins/charts/common/constants.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx new file mode 100644 index 0000000000000..1cbdb2f19a6fb --- /dev/null +++ b/api_docs/charts.mdx @@ -0,0 +1,44 @@ +--- +id: kibChartsPluginApi +slug: /kibana-dev-docs/chartsPluginApi +title: charts +image: https://source.unsplash.com/400x175/?github +summary: API docs for the charts plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import chartsObj from './charts.json'; + +## Client + +### Start + + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/cloud.json b/api_docs/cloud.json new file mode 100644 index 0000000000000..d51ccdb93f3d7 --- /dev/null +++ b/api_docs/cloud.json @@ -0,0 +1,249 @@ +{ + "id": "cloud", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.CloudConfigType", + "type": "Interface", + "label": "CloudConfigType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CloudConfigType.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L17" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudConfigType.resetPasswordUrl", + "type": "string", + "label": "resetPasswordUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudConfigType.deploymentUrl", + "type": "string", + "label": "deploymentUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L19" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudConfigType.accountUrl", + "type": "string", + "label": "accountUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L16" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.CloudSetup", + "type": "Interface", + "label": "CloudSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CloudSetup.cloudId", + "type": "string", + "label": "cloudId", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudSetup.cloudDeploymentUrl", + "type": "string", + "label": "cloudDeploymentUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L33" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudSetup.isCloudEnabled", + "type": "boolean", + "label": "isCloudEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L34" + } + }, + { + "tags": [], + "id": "def-public.CloudSetup.resetPasswordUrl", + "type": "string", + "label": "resetPasswordUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L35" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CloudSetup.accountUrl", + "type": "string", + "label": "accountUrl", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L36" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/cloud/public/plugin.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L31" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.CloudSetup", + "type": "Interface", + "label": "CloudSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.CloudSetup.cloudId", + "type": "string", + "label": "cloudId", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L19" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.CloudSetup.isCloudEnabled", + "type": "boolean", + "label": "isCloudEnabled", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L20" + } + }, + { + "tags": [], + "id": "def-server.CloudSetup.apm", + "type": "Object", + "label": "apm", + "description": [], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L21" + }, + "signature": [ + "{ url?: string | undefined; secretToken?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/cloud/server/plugin.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L18" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx new file mode 100644 index 0000000000000..4a61ce885f154 --- /dev/null +++ b/api_docs/cloud.mdx @@ -0,0 +1,26 @@ +--- +id: kibCloudPluginApi +slug: /kibana-dev-docs/cloudPluginApi +title: cloud +image: https://source.unsplash.com/400x175/?github +summary: API docs for the cloud plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import cloudObj from './cloud.json'; + +## Client + +### Setup + + +### Interfaces + + +## Server + +### Setup + + diff --git a/api_docs/console.json b/api_docs/console.json new file mode 100644 index 0000000000000..9720d7229cb76 --- /dev/null +++ b/api_docs/console.json @@ -0,0 +1,65 @@ +{ + "id": "console", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.ConsoleSetup", + "type": "Type", + "label": "ConsoleSetup", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/console/server/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L13" + }, + "signature": [ + "{ addExtensionSpecFilePath: (path: string) => void; }" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.ConsoleStart", + "type": "Type", + "label": "ConsoleStart", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/console/server/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L18" + }, + "signature": [ + "{ addProcessorDefinition: (processor: any) => void; }" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/console.mdx b/api_docs/console.mdx new file mode 100644 index 0000000000000..3514fa2697aaa --- /dev/null +++ b/api_docs/console.mdx @@ -0,0 +1,21 @@ +--- +id: kibConsolePluginApi +slug: /kibana-dev-docs/consolePluginApi +title: console +image: https://source.unsplash.com/400x175/?github +summary: API docs for the console plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import consoleObj from './console.json'; + +## Server + +### Setup + + +### Start + + diff --git a/api_docs/core.json b/api_docs/core.json new file mode 100644 index 0000000000000..ad83038c3fb3f --- /dev/null +++ b/api_docs/core.json @@ -0,0 +1,17763 @@ +{ + "id": "core", + "client": { + "classes": [ + { + "id": "def-public.ToastsApi", + "type": "Class", + "tags": [ + "public" + ], + "label": "ToastsApi", + "description": [ + "\nMethods for adding and removing global toast messages." + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + " implements Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ], + "children": [ + { + "id": "def-public.ToastsApi.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.ToastsApi.Unnamed.deps", + "type": "Object", + "label": "deps", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ToastsApi.Unnamed.deps.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + } + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102" + } + }, + { + "id": "def-public.ToastsApi.get$", + "type": "Function", + "label": "get$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L113" + } + }, + { + "id": "def-public.ToastsApi.add", + "type": "Function", + "label": "add", + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast to current array of toast.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrTitle", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + } + ], + "description": [ + "- a {@link ToastInput}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L123" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L123" + } + }, + { + "id": "def-public.ToastsApi.remove", + "type": "Function", + "label": "remove", + "signature": [ + "(toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void" + ], + "description": [ + "\nRemoves a toast from the current array of toasts if present." + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrId", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L139" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L139" + } + }, + { + "id": "def-public.ToastsApi.addInfo", + "type": "Function", + "label": "addInfo", + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast pre-configured with the info color and info icon.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrTitle", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + } + ], + "description": [ + "- a {@link ToastInput}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined" + ], + "description": [ + "- a {@link ToastOptions}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155" + } + }, + { + "id": "def-public.ToastsApi.addSuccess", + "type": "Function", + "label": "addSuccess", + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast pre-configured with the success color and check icon.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrTitle", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + } + ], + "description": [ + "- a {@link ToastInput}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined" + ], + "description": [ + "- a {@link ToastOptions}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171" + } + }, + { + "id": "def-public.ToastsApi.addWarning", + "type": "Function", + "label": "addWarning", + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast pre-configured with the warning color and help icon.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrTitle", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + } + ], + "description": [ + "- a {@link ToastInput}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined" + ], + "description": [ + "- a {@link ToastOptions}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187" + } + }, + { + "id": "def-public.ToastsApi.addDanger", + "type": "Function", + "label": "addDanger", + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast pre-configured with the danger color and alert icon.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "toastOrTitle", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + } + ], + "description": [ + "- a {@link ToastInput}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined" + ], + "description": [ + "- a {@link ToastOptions}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204" + } + }, + { + "id": "def-public.ToastsApi.addError", + "type": "Function", + "label": "addError", + "signature": [ + "(error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [ + "\nAdds a new toast that displays an exception message with a button to open the full stacktrace in a modal.\n" + ], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [ + "- an `Error` instance." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + } + ], + "description": [ + "- {@link ErrorToastOptions}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221" + } + } + ], + "tags": [], + "returnComment": [ + "a {@link Toast}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221" + } + } + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L94" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.PackageInfo", + "type": "Interface", + "label": "PackageInfo", + "signature": [ + "PackageInfo" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.PackageInfo.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 5, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L5" + } + }, + { + "tags": [], + "id": "def-public.PackageInfo.branch", + "type": "string", + "label": "branch", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 6, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L6" + } + }, + { + "tags": [], + "id": "def-public.PackageInfo.buildNum", + "type": "number", + "label": "buildNum", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 7, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L7" + } + }, + { + "tags": [], + "id": "def-public.PackageInfo.buildSha", + "type": "string", + "label": "buildSha", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L8" + } + }, + { + "tags": [], + "id": "def-public.PackageInfo.dist", + "type": "boolean", + "label": "dist", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L9" + } + } + ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 4, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L4" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EnvironmentMode", + "type": "Interface", + "label": "EnvironmentMode", + "signature": [ + "EnvironmentMode" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.EnvironmentMode.name", + "type": "CompoundType", + "label": "name", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L15" + }, + "signature": [ + "\"production\" | \"development\"" + ] + }, + { + "tags": [], + "id": "def-public.EnvironmentMode.dev", + "type": "boolean", + "label": "dev", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.EnvironmentMode.prod", + "type": "boolean", + "label": "prod", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L17" + } + } + ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IExternalUrlPolicy", + "type": "Interface", + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L33" + } + }, + { + "tags": [ + "example" + ], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L46" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L59" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-public.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", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppCategory.id", + "type": "string", + "label": "id", + "description": [ + "\nUnique identifier for the categories" + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25" + } + }, + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UiSettingsParams", + "type": "Interface", + "label": "UiSettingsParams", + "signature": [ + "UiSettingsParams", + "" + ], + "description": [ + "\nUiSettings parameters defined by the plugins." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.UiSettingsParams.name", + "type": "string", + "label": "name", + "description": [ + "title in the UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.value", + "type": "Uncategorized", + "label": "value", + "description": [ + "default value to fall back to if a user doesn't provide any" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L47" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.description", + "type": "string", + "label": "description", + "description": [ + "description provided to a user in UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L49" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.category", + "type": "Array", + "label": "category", + "description": [ + "used to group the configured setting in the UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L51" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.options", + "type": "Array", + "label": "options", + "description": [ + "array of permitted values for this setting" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L53" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.optionLabels", + "type": "Object", + "label": "optionLabels", + "description": [ + "text labels for 'select' type UI element" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L55" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.requiresPageReload", + "type": "CompoundType", + "label": "requiresPageReload", + "description": [ + "a flag indicating whether new value applying requires page reloading" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L57" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.readonly", + "type": "CompoundType", + "label": "readonly", + "description": [ + "a flag indicating that value cannot be changed" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L59" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.sensitive", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.type", + "type": "CompoundType", + "label": "type", + "description": [ + "defines a type of UI element {@link UiSettingsType}" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L66" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.deprecation", + "type": "Object", + "label": "deprecation", + "description": [ + "optional deprecation information. Used to generate a deprecation warning." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L68" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.DeprecationSettings", + "text": "DeprecationSettings" + }, + " | undefined" + ] + }, + { + "tags": [ + "remark" + ], + "id": "def-public.UiSettingsParams.order", + "type": "number", + "label": "order", + "description": [ + "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L75" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.validation", + "type": "CompoundType", + "label": "validation", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L81" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.ImageValidation", + "text": "ImageValidation" + }, + " | ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.StringValidationRegex", + "text": "StringValidationRegex" + }, + " | ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.StringValidationRegexString", + "text": "StringValidationRegexString" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UiSettingsParams.schema", + "type": "Object", + "label": "schema", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L86" + }, + "signature": [ + "Type", + "" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L92" + }, + "signature": [ + "{ type: ", + "UiCounterMetricType", + "; name: string; } | undefined" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UserProvidedValues", + "type": "Interface", + "label": "UserProvidedValues", + "signature": [ + "UserProvidedValues", + "" + ], + "description": [ + "\nDescribes the values explicitly set by user." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.UserProvidedValues.userValue", + "type": "Uncategorized", + "label": "userValue", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L143" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UserProvidedValues.isOverridden", + "type": "CompoundType", + "label": "isOverridden", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L144" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L142" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ImageValidation", + "type": "Interface", + "label": "ImageValidation", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ImageValidation.maxSize", + "type": "Object", + "label": "maxSize", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L132" + }, + "signature": [ + "{ length: number; description: string; }" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L131" + }, + "initialIsOpen": false + }, + { + "id": "def-public.StringValidationRegex", + "type": "Interface", + "label": "StringValidationRegex", + "description": [ + "\nStringValidation with regex object" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.StringValidationRegex.regex", + "type": "Object", + "label": "regex", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L115" + }, + "signature": [ + "RegExp" + ] + }, + { + "tags": [], + "id": "def-public.StringValidationRegex.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L116" + } + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L114" + }, + "initialIsOpen": false + }, + { + "id": "def-public.StringValidationRegexString", + "type": "Interface", + "label": "StringValidationRegexString", + "description": [ + "\nStringValidation as regex string" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.StringValidationRegexString.regexString", + "type": "string", + "label": "regexString", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L124" + } + }, + { + "tags": [], + "id": "def-public.StringValidationRegexString.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L125" + } + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L123" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObject", + "type": "Interface", + "label": "SavedObject", + "signature": [ + "SavedObject", + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedObject.id", + "type": "string", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" + } + }, + { + "tags": [], + "id": "def-public.SavedObject.type", + "type": "string", + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" + } + }, + { + "tags": [], + "id": "def-public.SavedObject.version", + "type": "string", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.updated_at", + "type": "string", + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.references", + "type": "Array", + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObject.originId", + "type": "string", + "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." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectAttributes", + "type": "Interface", + "label": "SavedObjectAttributes", + "description": [ + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.SavedObjectAttributes.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectError", + "type": "Interface", + "label": "SavedObjectError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectError.error", + "type": "string", + "label": "error", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L99" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L100" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectError.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L101" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectError.metadata", + "type": "Object", + "label": "metadata", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L102" + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L98" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectReference", + "type": "Interface", + "label": "SavedObjectReference", + "description": [ + "\nA reference to another saved object.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectReference.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectReference.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectReference.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47" + } + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBaseOptions", + "type": "Interface", + "label": "SavedObjectsBaseOptions", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBaseOptions.namespace", + "type": "string", + "label": "namespace", + "description": [ + "Specify the namespace for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L141" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L139" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsFindOptions", + "type": "Interface", + "label": "SavedObjectsFindOptions", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.sortOrder", + "type": "string", + "label": "sortOrder", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L82" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.SavedObjectsFindOptions.fields", + "type": "Array", + "label": "fields", + "description": [ + "\nAn array of fields to include in the results" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L88" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.search", + "type": "string", + "label": "search", + "description": [ + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.searchFields", + "type": "Array", + "label": "searchFields", + "description": [ + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.searchAfter", + "type": "Array", + "label": "searchAfter", + "description": [ + "\nUse the sort values from the previous page to retrieve the next page of results." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96" + }, + "signature": [ + "unknown[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", + "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": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", + "label": "hasReferenceOperator", + "description": [ + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111" + }, + "signature": [ + "\"AND\" | \"OR\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "label": "defaultSearchOperator", + "description": [ + "\nThe search operator to use with the provided filter. Defaults to `OR`" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116" + }, + "signature": [ + "\"AND\" | \"OR\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.filter", + "type": "Any", + "label": "filter", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L117" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.namespaces", + "type": "Array", + "label": "namespaces", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L118" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126" + }, + "signature": [ + "Map | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.preference", + "type": "string", + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L128" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptions.pit", + "type": "Object", + "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": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L132" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsFindOptionsReference", + "type": "Interface", + "label": "SavedObjectsFindOptionsReference", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsFindOptionsReference.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L61" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindOptionsReference.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L62" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsMigrationVersion", + "type": "Interface", + "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": [ + "example", + "public" + ], + "children": [ + { + "id": "def-public.SavedObjectsMigrationVersion.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportResponse", + "type": "Interface", + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportResponse.successCount", + "type": "number", + "label": "successCount", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L143" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportResponse.successResults", + "type": "Array", + "label": "successResults", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportResponse.warnings", + "type": "Array", + "label": "warnings", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L145" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportResponse.errors", + "type": "Array", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L146" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L141" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportSuccess", + "type": "Interface", + "label": "SavedObjectsImportSuccess", + "description": [ + "\nRepresents a successful import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportSuccess.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L114" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportSuccess.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L115" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportSuccess.destinationId", + "type": "string", + "label": "destinationId", + "description": [ + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "label": "createNewCopy", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L126" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportSuccess.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L127" + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L134" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L113" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportConflictError", + "type": "Interface", + "label": "SavedObjectsImportConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportConflictError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L45" + }, + "signature": [ + "\"conflict\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportConflictError.destinationId", + "type": "string", + "label": "destinationId", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L46" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", + "label": "SavedObjectsImportAmbiguousConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L54" + }, + "signature": [ + "\"ambiguous_conflict\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "label": "destinations", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L55" + }, + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", + "label": "SavedObjectsImportUnsupportedTypeError", + "description": [ + "\nRepresents a failure to import due to having an unsupported saved object type." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L63" + }, + "signature": [ + "\"unsupported_type\"" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportMissingReferencesError", + "type": "Interface", + "label": "SavedObjectsImportMissingReferencesError", + "description": [ + "\nRepresents a failure to import due to missing references." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L81" + }, + "signature": [ + "\"missing_references\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L82" + }, + "signature": [ + "{ type: string; id: string; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportUnknownError", + "type": "Interface", + "label": "SavedObjectsImportUnknownError", + "description": [ + "\nRepresents a failure to import due to an unknown reason." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportUnknownError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L71" + }, + "signature": [ + "\"unknown\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportUnknownError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L72" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L73" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportFailure", + "type": "Interface", + "label": "SavedObjectsImportFailure", + "description": [ + "\nRepresents a failure to import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportFailure.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportFailure.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L91" + } + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.SavedObjectsImportFailure.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L95" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportFailure.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L96" + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L100" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportFailure.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L101" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportRetry", + "type": "Interface", + "label": "SavedObjectsImportRetry", + "description": [ + "\nDescribes a retry operation for importing a saved object." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "label": "overwrite", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.destinationId", + "type": "string", + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L23" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "label": "replaceReferences", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24" + }, + "signature": [ + "{ type: string; from: string; to: string; }[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L33" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L37" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportSimpleWarning", + "type": "Interface", + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportSimpleWarning.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L187" + }, + "signature": [ + "\"simple\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportSimpleWarning.message", + "type": "string", + "label": "message", + "description": [ + "The translated message to display to the user" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L189" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L186" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportActionRequiredWarning", + "type": "Interface", + "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": [ + "remark", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsImportActionRequiredWarning.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 201, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L201" + }, + "signature": [ + "\"action_required\"" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportActionRequiredWarning.message", + "type": "string", + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to to address this warning." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L205" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L207" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L200" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayStart", + "type": "Interface", + "label": "OverlayStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.OverlayStart.banners", + "type": "Object", + "label": "banners", + "description": [ + "{@link OverlayBannersStart}" + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L50" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayBannersStart", + "text": "OverlayBannersStart" + } + ] + }, + { + "tags": [], + "id": "def-public.OverlayStart.openFlyout", + "type": "Function", + "label": "openFlyout", + "description": [ + "{@link OverlayFlyoutStart#open}" + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L52" + }, + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ] + }, + { + "tags": [], + "id": "def-public.OverlayStart.openModal", + "type": "Function", + "label": "openModal", + "description": [ + "{@link OverlayModalStart#open}" + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L54" + }, + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ] + }, + { + "tags": [], + "id": "def-public.OverlayStart.openConfirm", + "type": "Function", + "label": "openConfirm", + "description": [ + "{@link OverlayModalStart#openConfirm}" + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L56" + }, + "signature": [ + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined) => Promise" + ] + } + ], + "source": { + "path": "src/core/public/overlays/overlay_service.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayBannersStart", + "type": "Interface", + "label": "OverlayBannersStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.OverlayBannersStart.add", + "type": "Function", + "label": "add", + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "description": [ + "\nAdd a new banner\n" + ], + "children": [ + { + "type": "Function", + "label": "mount", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30" + } + }, + { + "type": "number", + "label": "priority", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30" + } + } + ], + "tags": [ + "link" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30" + } + }, + { + "id": "def-public.OverlayBannersStart.remove", + "type": "Function", + "label": "remove", + "signature": [ + "(id: string) => boolean" + ], + "description": [ + "\nRemove a banner\n" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add}" + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L38" + } + } + ], + "tags": [], + "returnComment": [ + "if the banner was found or not" + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L38" + } + }, + { + "id": "def-public.OverlayBannersStart.replace", + "type": "Function", + "label": "replace", + "signature": [ + "(id: string | undefined, mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "description": [ + "\nReplace a banner in place\n" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add}" + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49" + } + }, + { + "type": "Function", + "label": "mount", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49" + } + }, + { + "type": "number", + "label": "priority", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49" + } + } + ], + "tags": [ + "link" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49" + } + }, + { + "id": "def-public.OverlayBannersStart.getComponent", + "type": "Function", + "label": "getComponent", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L53" + } + } + ], + "source": { + "path": "src/core/public/overlays/banners/banners_service.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayRef", + "type": "Interface", + "label": "OverlayRef", + "description": [ + "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.OverlayRef.onClose", + "type": "Object", + "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`." + ], + "source": { + "path": "src/core/public/overlays/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L20" + }, + "signature": [ + "Promise" + ] + }, + { + "id": "def-public.OverlayRef.close", + "type": "Function", + "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": [], + "source": { + "path": "src/core/public/overlays/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L27" + } + } + ], + "source": { + "path": "src/core/public/overlays/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayFlyoutStart", + "type": "Interface", + "label": "OverlayFlyoutStart", + "description": [ + "\nAPIs to open and manage fly-out dialogs.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.OverlayFlyoutStart.open", + "type": "Function", + "label": "open", + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "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" + ], + "children": [ + { + "type": "Function", + "label": "mount", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74" + } + } + ], + "tags": [ + "link", + "link", + "return", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74" + } + } + ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayFlyoutOpenOptions", + "type": "Interface", + "label": "OverlayFlyoutOpenOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L81" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", + "type": "string", + "label": "closeButtonAriaLabel", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L82" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", + "type": "CompoundType", + "label": "ownFocus", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L83" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.'data-test-subj'", + "type": "string", + "label": "'data-test-subj'", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L84" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.size", + "type": "CompoundType", + "label": "size", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L85" + }, + "signature": [ + "\"m\" | \"s\" | \"l\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", + "type": "CompoundType", + "label": "maxWidth", + "description": [], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L86" + }, + "signature": [ + "string | number | boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayModalOpenOptions", + "type": "Interface", + "label": "OverlayModalOpenOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.OverlayModalOpenOptions.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L101" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", + "type": "string", + "label": "closeButtonAriaLabel", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L102" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalOpenOptions.'data-test-subj'", + "type": "string", + "label": "'data-test-subj'", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L103" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalOpenOptions.maxWidth", + "type": "CompoundType", + "label": "maxWidth", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L104" + }, + "signature": [ + "string | number | boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L100" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayModalConfirmOptions", + "type": "Interface", + "label": "OverlayModalConfirmOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", + "type": "string", + "label": "cancelButtonText", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L55" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", + "type": "string", + "label": "confirmButtonText", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L56" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L57" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", + "type": "string", + "label": "closeButtonAriaLabel", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.'data-test-subj'", + "type": "string", + "label": "'data-test-subj'", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L59" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", + "type": "CompoundType", + "label": "defaultFocusedButton", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L60" + }, + "signature": [ + "\"cancel\" | \"confirm\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.buttonColor", + "type": "CompoundType", + "label": "buttonColor", + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L61" + }, + "signature": [ + "\"warning\" | \"text\" | \"primary\" | \"danger\" | \"secondary\" | \"ghost\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OverlayModalConfirmOptions.maxWidth", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L69" + }, + "signature": [ + "string | number | boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OverlayModalStart", + "type": "Interface", + "label": "OverlayModalStart", + "description": [ + "\nAPIs to open and manage modal dialogs.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.OverlayModalStart.open", + "type": "Function", + "label": "open", + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "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" + ], + "children": [ + { + "type": "Function", + "label": "mount", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86" + } + } + ], + "tags": [ + "link", + "link", + "return", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86" + } + }, + { + "id": "def-public.OverlayModalStart.openConfirm", + "type": "Function", + "label": "openConfirm", + "signature": [ + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | 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" + ], + "children": [ + { + "type": "CompoundType", + "label": "message", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94" + } + } + ], + "tags": [ + "link", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94" + } + } + ], + "source": { + "path": "src/core/public/overlays/modal/modal_service.tsx", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ToastOptions", + "type": "Interface", + "label": "ToastOptions", + "description": [ + "\nOptions available for {@link IToasts} APIs." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ToastOptions.toastLifeTimeMs", + "type": "number", + "label": "toastLifeTimeMs", + "description": [ + "\nHow long should the toast remain on screen." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L51" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ErrorToastOptions", + "type": "Interface", + "label": "ErrorToastOptions", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + } + ], + "description": [ + "\nOptions available for {@link IToasts} error APIs." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ErrorToastOptions.title", + "type": "string", + "label": "title", + "description": [ + "\nThe title of the toast and the dialog when expanding the message." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L62" + } + }, + { + "tags": [], + "id": "def-public.ErrorToastOptions.toastMessage", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L69" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CoreSetup", + "type": "Interface", + "label": "CoreSetup", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [ + "\nCore services exposed to the `Plugin` setup lifecycle\n" + ], + "tags": [ + "typeParam", + "typeParam", + "public", + "internalRemarks", + "link" + ], + "children": [ + { + "tags": [], + "id": "def-public.CoreSetup.application", + "type": "Object", + "label": "application", + "description": [ + "{@link ApplicationSetup}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L208" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationSetup", + "text": "ApplicationSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreSetup.fatalErrors", + "type": "Object", + "label": "fatalErrors", + "description": [ + "{@link FatalErrorsSetup}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L210" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreSetup.http", + "type": "Object", + "label": "http", + "description": [ + "{@link HttpSetup}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L212" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreSetup.notifications", + "type": "Object", + "label": "notifications", + "description": [ + "{@link NotificationsSetup}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L214" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsSetup", + "text": "NotificationsSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreSetup.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link IUiSettingsClient}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L216" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + }, + { + "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." + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L223" + }, + "signature": [ + "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + ] + }, + { + "tags": [], + "id": "def-public.CoreSetup.getStartServices", + "type": "Function", + "label": "getStartServices", + "description": [ + "{@link StartServicesAccessor}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L227" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.StartServicesAccessor", + "text": "StartServicesAccessor" + }, + "" + ] + } + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L206" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CoreStart", + "type": "Interface", + "label": "CoreStart", + "description": [ + "\nCore services exposed to the `Plugin` start lifecycle\n" + ], + "tags": [ + "public", + "internalRemarks", + "link" + ], + "children": [ + { + "tags": [], + "id": "def-public.CoreStart.application", + "type": "Object", + "label": "application", + "description": [ + "{@link ApplicationStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L253" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.chrome", + "type": "Object", + "label": "chrome", + "description": [ + "{@link ChromeStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L255" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeStart", + "text": "ChromeStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.docLinks", + "type": "Object", + "label": "docLinks", + "description": [ + "{@link DocLinksStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L257" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.DocLinksStart", + "text": "DocLinksStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.http", + "type": "Object", + "label": "http", + "description": [ + "{@link HttpStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L259" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [ + "{@link SavedObjectsStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L261" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsStart", + "text": "SavedObjectsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.i18n", + "type": "Object", + "label": "i18n", + "description": [ + "{@link I18nStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 263, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L263" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.I18nStart", + "text": "I18nStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.notifications", + "type": "Object", + "label": "notifications", + "description": [ + "{@link NotificationsStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 265, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L265" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.overlays", + "type": "Object", + "label": "overlays", + "description": [ + "{@link OverlayStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L267" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayStart", + "text": "OverlayStart" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link IUiSettingsClient}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L269" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + }, + { + "tags": [], + "id": "def-public.CoreStart.fatalErrors", + "type": "Object", + "label": "fatalErrors", + "description": [ + "{@link FatalErrorsStart}" + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 271, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L271" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + } + ] + }, + { + "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." + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 278, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L278" + }, + "signature": [ + "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" + ] + } + ], + "source": { + "path": "src/core/public/index.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L251" + }, + "initialIsOpen": false + }, + { + "id": "def-public.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-public.Capabilities.navLinks", + "type": "Object", + "label": "navLinks", + "description": [ + "Navigation link capabilities." + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L18" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.Capabilities.management", + "type": "Object", + "label": "management", + "description": [ + "Management section capabilities." + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L21" + }, + "signature": [ + "{ [sectionId: string]: Record; }" + ] + }, + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L26" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-public.Capabilities.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [ + "Custom capabilities, registered by plugins." + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L29" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DocLinksStart", + "type": "Interface", + "label": "DocLinksStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.DocLinksStart.DOC_LINK_VERSION", + "type": "string", + "label": "DOC_LINK_VERSION", + "description": [], + "source": { + "path": "src/core/public/doc_links/doc_links_service.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L282" + } + }, + { + "tags": [], + "id": "def-public.DocLinksStart.ELASTIC_WEBSITE_URL", + "type": "string", + "label": "ELASTIC_WEBSITE_URL", + "description": [], + "source": { + "path": "src/core/public/doc_links/doc_links_service.ts", + "lineNumber": 283, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L283" + } + }, + { + "tags": [], + "id": "def-public.DocLinksStart.links", + "type": "Object", + "label": "links", + "description": [], + "source": { + "path": "src/core/public/doc_links/doc_links_service.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L284" + }, + "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: 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 loadingData: string; readonly introduction: 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; 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; }" + ] + } + ], + "source": { + "path": "src/core/public/doc_links/doc_links_service.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L281" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FatalErrorInfo", + "type": "Interface", + "label": "FatalErrorInfo", + "description": [ + "\nRepresents the `message` and `stack` of a fatal Error\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.FatalErrorInfo.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/public/fatal_errors/get_error_info.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L73" + } + }, + { + "tags": [], + "id": "def-public.FatalErrorInfo.stack", + "type": "string", + "label": "stack", + "description": [], + "source": { + "path": "src/core/public/fatal_errors/get_error_info.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L74" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/fatal_errors/get_error_info.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L72" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FatalErrorsSetup", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.FatalErrorsSetup.add", + "type": "Function", + "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" + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L38" + }, + "signature": [ + "(error: string | Error, source?: string | undefined) => never" + ] + }, + { + "tags": [], + "id": "def-public.FatalErrorsSetup.get$", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L43" + }, + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorInfo", + "text": "FatalErrorInfo" + }, + ">" + ] + } + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-public.I18nStart", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.I18nStart.Context", + "type": "Function", + "label": "Context", + "description": [ + "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + ], + "source": { + "path": "src/core/public/i18n/i18n_service.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/i18n/i18n_service.tsx#L65" + }, + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ] + } + ], + "source": { + "path": "src/core/public/i18n/i18n_service.tsx", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/i18n/i18n_service.tsx#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-public.NotificationsSetup", + "type": "Interface", + "label": "NotificationsSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.NotificationsSetup.toasts", + "type": "Object", + "label": "toasts", + "description": [ + "{@link ToastsSetup}" + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L78" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ] + } + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L76" + }, + "initialIsOpen": false + }, + { + "id": "def-public.NotificationsStart", + "type": "Interface", + "label": "NotificationsStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.NotificationsStart.toasts", + "type": "Object", + "label": "toasts", + "description": [ + "{@link ToastsStart}" + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L84" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ] + } + ], + "source": { + "path": "src/core/public/notifications/notifications_service.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L82" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Plugin", + "type": "Interface", + "label": "Plugin", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" + ], + "description": [ + "\nThe interface that should be returned by a `PluginInitializer`.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.Plugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsSetup" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28" + } + }, + { + "id": "def-public.Plugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsStart" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29" + } + }, + { + "id": "def-public.Plugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "(() => void) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L30" + } + } + ], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AsyncPlugin", + "type": "Interface", + "label": "AsyncPlugin", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.AsyncPlugin", + "text": "AsyncPlugin" + }, + "" + ], + "description": [ + "\nA plugin with asynchronous lifecycle methods.\n" + ], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "id": "def-public.AsyncPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup | Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsSetup" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45" + } + }, + { + "id": "def-public.AsyncPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart | Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsStart" + ], + "description": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46" + } + }, + { + "id": "def-public.AsyncPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "(() => void) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L47" + } + } + ], + "source": { + "path": "src/core/public/plugins/plugin.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PluginInitializerContext", + "type": "Interface", + "label": "PluginInitializerContext", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [ + "\nThe available core services passed to a `PluginInitializer`\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.PluginInitializerContext.opaqueId", + "type": "Uncategorized", + "label": "opaqueId", + "description": [ + "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." + ], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L26" + }, + "signature": [ + "symbol" + ] + }, + { + "tags": [], + "id": "def-public.PluginInitializerContext.env", + "type": "Object", + "label": "env", + "description": [], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L27" + }, + "signature": [ + "{ mode: Readonly<", + "EnvironmentMode", + ">; packageInfo: Readonly<", + "PackageInfo", + ">; }" + ] + }, + { + "tags": [], + "id": "def-public.PluginInitializerContext.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L31" + }, + "signature": [ + "{ get: () => T; }" + ] + } + ], + "source": { + "path": "src/core/public/plugins/plugin_context.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IUiSettingsClient", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.IUiSettingsClient.get", + "type": "Function", + "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." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L33" + }, + "signature": [ + "(key: string, defaultOverride?: T | undefined) => T" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.get$", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L39" + }, + "signature": [ + "(key: string, defaultOverride?: T | undefined) => ", + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.getAll", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L45" + }, + "signature": [ + "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\"> & ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.UserProvidedValues", + "text": "UserProvidedValues" + }, + ">>" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.set", + "type": "Function", + "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." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L54" + }, + "signature": [ + "(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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L60" + }, + "signature": [ + "(key: string, newDefault: any) => void" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.remove", + "type": "Function", + "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." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L67" + }, + "signature": [ + "(key: string) => Promise" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.isDeclared", + "type": "Function", + "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." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L73" + }, + "signature": [ + "(key: string) => boolean" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.isDefault", + "type": "Function", + "label": "isDefault", + "description": [ + "\nReturns true if the setting has no user-defined value or is unknown" + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L78" + }, + "signature": [ + "(key: string) => boolean" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.isCustom", + "type": "Function", + "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" + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L85" + }, + "signature": [ + "(key: string) => boolean" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.isOverridden", + "type": "Function", + "label": "isOverridden", + "description": [ + "\nShows whether the uiSettings value set by the user." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L90" + }, + "signature": [ + "(key: string) => boolean" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.getUpdate$", + "type": "Function", + "label": "getUpdate$", + "description": [ + "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L96" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L106" + }, + "signature": [ + "() => ", + "Observable", + "<{ key: string; newValue: T; oldValue: T; }>" + ] + }, + { + "tags": [], + "id": "def-public.IUiSettingsClient.getUpdateErrors$", + "type": "Function", + "label": "getUpdateErrors$", + "description": [ + "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L116" + }, + "signature": [ + "() => ", + "Observable", + "" + ] + } + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UiSettingsState", + "type": "Interface", + "label": "UiSettingsState", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.UiSettingsState.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L14" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/public/ui_settings/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L13" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.UiSettingsType", + "type": "Type", + "label": "UiSettingsType", + "tags": [ + "public" + ], + "description": [ + "\nUI element type to represent the settings." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L16" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.StringValidation", + "type": "Type", + "label": "StringValidation", + "tags": [ + "public" + ], + "description": [ + "\nAllows regex objects or a regex string" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L108" + }, + "signature": [ + "StringValidationRegex", + " | ", + "StringValidationRegexString" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectAttribute", + "type": "Type", + "label": "SavedObjectAttribute", + "tags": [ + "public" + ], + "description": [ + "\nType definition for a Saved Object attribute value\n" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L27" + }, + "signature": [ + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectAttributeSingle", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L14" + }, + "signature": [ + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsNamespaceType", + "type": "Type", + "label": "SavedObjectsNamespaceType", + "tags": [ + "public" + ], + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L226" + }, + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsImportWarning", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L218" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSimpleWarning", + "text": "SavedObjectsImportSimpleWarning" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportActionRequiredWarning", + "text": "SavedObjectsImportActionRequiredWarning" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.Toast", + "type": "Type", + "label": "Toast", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L33" + }, + "signature": [ + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ToastInput", + "type": "Type", + "label": "ToastInput", + "tags": [ + "public" + ], + "description": [ + "\nInputs for {@link IToasts} APIs." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L41" + }, + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.IToasts", + "type": "Type", + "label": "IToasts", + "tags": [ + "public" + ], + "description": [ + "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L85" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ToastInputFields", + "type": "Type", + "label": "ToastInputFields", + "tags": [ + "remarks", + "public" + ], + "description": [ + "\nAllowed fields for {@link ToastInput}.\n" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L28" + }, + "signature": [ + "Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ToastsSetup", + "type": "Type", + "label": "ToastsSetup", + "tags": [ + "public" + ], + "description": [ + "\n{@link IToasts}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_service.tsx#L32" + }, + "signature": [ + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.ToastsStart", + "type": "Type", + "label": "ToastsStart", + "tags": [ + "public" + ], + "description": [ + "\n{@link IToasts}" + ], + "source": { + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_service.tsx#L38" + }, + "signature": [ + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.MountPoint", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/types.ts#L27" + }, + "signature": [ + "(element: T) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.UnmountCallback", + "type": "Type", + "label": "UnmountCallback", + "tags": [ + "public" + ], + "description": [ + "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" + ], + "source": { + "path": "src/core/public/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/types.ts#L35" + }, + "signature": [ + "() => void" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PublicUiSettingsParams", + "type": "Type", + "label": "PublicUiSettingsParams", + "tags": [ + "public" + ], + "description": [ + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L102" + }, + "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; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; }" + ], + "initialIsOpen": false + }, + { + "tags": [ + "public" + ], + "id": "def-public.URL_MAX_LENGTH", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/core_app/errors/url_overflow.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/core_app/errors/url_overflow.tsx#L27" + }, + "signature": [ + "2000 | 25000" + ], + "initialIsOpen": false + }, + { + "id": "def-public.StartServicesAccessor", + "type": "Type", + "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": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L237" + }, + "signature": [ + "() => Promise<[", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", TPluginsStart, TStart]>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FatalErrorsStart", + "type": "Type", + "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" + ], + "source": { + "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L52" + }, + "signature": [ + "FatalErrorsSetup" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PluginInitializer", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L56" + }, + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.AsyncPlugin", + "text": "AsyncPlugin" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PluginOpaqueId", + "type": "Type", + "label": "PluginOpaqueId", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L84" + }, + "signature": [ + "symbol" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.CspConfig", + "type": "Class", + "tags": [ + "public" + ], + "label": "CspConfig", + "description": [ + "\nCSP configuration for use in Kibana." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CspConfig", + "text": "CspConfig" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICspConfig", + "text": "ICspConfig" + } + ], + "children": [ + { + "tags": [], + "id": "def-server.CspConfig.DEFAULT", + "type": "Object", + "label": "DEFAULT", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L47" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CspConfig", + "text": "CspConfig" + } + ] + }, + { + "tags": [], + "id": "def-server.CspConfig.rules", + "type": "Array", + "label": "rules", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L49" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.CspConfig.strict", + "type": "boolean", + "label": "strict", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L50" + } + }, + { + "tags": [], + "id": "def-server.CspConfig.warnLegacyBrowsers", + "type": "boolean", + "label": "warnLegacyBrowsers", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L51" + } + }, + { + "tags": [], + "id": "def-server.CspConfig.header", + "type": "string", + "label": "header", + "description": [], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L52" + } + } + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyClusterClient", + "type": "Class", + "tags": [ + "deprecated", + "public" + ], + "label": "LegacyClusterClient", + "description": [ + "\n{@inheritDoc IClusterClient}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" + }, + " implements Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" + }, + ", \"callAsInternalUser\" | \"asScoped\">" + ], + "children": [ + { + "id": "def-server.LegacyClusterClient.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyElasticsearchClientConfig", + "text": "LegacyElasticsearchClientConfig" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L122" + } + }, + { + "type": "Object", + "label": "log", + "isRequired": true, + "signature": [ + "Logger" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L123" + } + }, + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L124" + } + }, + { + "type": "Function", + "label": "getAuthHeaders", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.GetAuthHeaders", + "text": "GetAuthHeaders" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L125" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L121" + } + }, + { + "id": "def-server.LegacyClusterClient.callAsInternalUser", + "type": "Function", + "children": [ + { + "type": "string", + "label": "endpoint", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L141" + } + }, + { + "type": "Object", + "label": "clientParams", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L142" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L143" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L140" + }, + "tags": [ + "deprecated" + ], + "returnComment": [] + }, + { + "id": "def-server.LegacyClusterClient.close", + "type": "Function", + "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": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L158" + } + }, + { + "id": "def-server.LegacyClusterClient.asScoped", + "type": "Function", + "label": "asScoped", + "signature": [ + "(request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"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" + ], + "children": [ + { + "type": "CompoundType", + "label": "request", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyScopedClusterClient", + "type": "Class", + "tags": [ + "deprecated", + "public" + ], + "label": "LegacyScopedClusterClient", + "description": [ + "\n{@inheritDoc IScopedClusterClient}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + " implements Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">" + ], + "children": [ + { + "id": "def-server.LegacyScopedClusterClient.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "internalAPICaller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L36" + } + }, + { + "type": "Function", + "label": "scopedAPICaller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L37" + } + }, + { + "type": "CompoundType", + "label": "headers", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L35" + } + }, + { + "id": "def-server.LegacyScopedClusterClient.callAsInternalUser", + "type": "Function", + "label": "callAsInternalUser", + "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}." + ], + "children": [ + { + "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": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L55" + } + }, + { + "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": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L56" + } + }, + { + "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": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L57" + } + } + ], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L54" + } + }, + { + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser", + "type": "Function", + "label": "callAsCurrentUser", + "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\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}." + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L73" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L74" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L75" + } + } + ], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L72" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchConfig", + "type": "Class", + "tags": [ + "public" + ], + "label": "ElasticsearchConfig", + "description": [ + "\nWrapper of config schema." + ], + "children": [ + { + "tags": [], + "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "type": "Object", + "label": "healthCheckDelay", + "description": [ + "\nThe interval between health check requests Kibana sends to the Elasticsearch." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L192" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", + "type": "boolean", + "label": "ignoreVersionMismatch", + "description": [ + "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L197" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.apiVersion", + "type": "string", + "label": "apiVersion", + "description": [ + "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L202" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.hosts", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L208" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L215" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.pingTimeout", + "type": "Object", + "label": "pingTimeout", + "description": [ + "\nTimeout after which PING HTTP request will be aborted and retried." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L220" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.requestTimeout", + "type": "Object", + "label": "requestTimeout", + "description": [ + "\nTimeout after which HTTP request will be aborted and retried." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L225" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.shardTimeout", + "type": "Object", + "label": "shardTimeout", + "description": [ + "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L230" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffOnStart", + "type": "boolean", + "label": "sniffOnStart", + "description": [ + "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L236" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffInterval", + "type": "CompoundType", + "label": "sniffInterval", + "description": [ + "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L242" + }, + "signature": [ + "false | moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", + "type": "boolean", + "label": "sniffOnConnectionFault", + "description": [ + "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L248" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.username", + "type": "string", + "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." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L254" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.password", + "type": "string", + "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." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L260" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.ssl", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L267" + }, + "signature": [ + "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.customHeaders", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L277" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-server.ElasticsearchConfig.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "rawConfig", + "isRequired": true, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 279, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L188" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyElasticsearchErrorHelpers", + "type": "Class", + "tags": [ + "public", + "example" + ], + "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]`" + ], + "children": [ + { + "id": "def-server.LegacyElasticsearchErrorHelpers.isNotAuthorizedError", + "type": "Function", + "label": "isNotAuthorizedError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyElasticsearchErrorHelpers", + "text": "LegacyElasticsearchErrorHelpers" + }, + ".isNotAuthorizedError" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "error", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L70" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L70" + } + }, + { + "id": "def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError", + "type": "Function", + "label": "decorateNotAuthorizedError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyElasticsearchErrorHelpers", + "text": "LegacyElasticsearchErrorHelpers" + }, + ".decorateNotAuthorizedError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L69" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L18" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L21" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L26" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L29" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/capabilities.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ResolveCapabilitiesOptions", + "type": "Interface", + "label": "ResolveCapabilitiesOptions", + "description": [ + "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", + "type": "boolean", + "label": "useDefaultCapabilities", + "description": [ + "\nIndicates if capability switchers are supposed to return a default set of capabilities." + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L105" + } + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L101" + }, + "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": [ + "example", + "public" + ], + "children": [ + { + "id": "def-server.ConfigDeprecationFactory.rename", + "type": "Function", + "label": "rename", + "signature": [ + "(oldKey: string, newKey: string) => ", + "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": [ + { + "type": "string", + "label": "oldKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63" + } + }, + { + "type": "string", + "label": "newKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63" + } + }, + { + "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "type": "Function", + "label": "renameFromRoot", + "signature": [ + "(oldKey: string, newKey: string, silent?: boolean | 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": [ + { + "type": "string", + "label": "oldKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79" + } + }, + { + "type": "string", + "label": "newKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79" + } + }, + { + "type": "CompoundType", + "label": "silent", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79" + } + }, + { + "id": "def-server.ConfigDeprecationFactory.unused", + "type": "Function", + "label": "unused", + "signature": [ + "(unusedKey: string) => ", + "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": [ + { + "type": "string", + "label": "unusedKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L92" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L92" + } + }, + { + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "type": "Function", + "label": "unusedFromRoot", + "signature": [ + "(unusedKey: string) => ", + "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": [ + { + "type": "string", + "label": "unusedKey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L108" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L108" + } + } + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L50" + }, + "initialIsOpen": false + }, + { + "id": "def-server.EnvironmentMode", + "type": "Interface", + "label": "EnvironmentMode", + "signature": [ + "EnvironmentMode" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.EnvironmentMode.name", + "type": "CompoundType", + "label": "name", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L15" + }, + "signature": [ + "\"production\" | \"development\"" + ] + }, + { + "tags": [], + "id": "def-server.EnvironmentMode.dev", + "type": "boolean", + "label": "dev", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L16" + } + }, + { + "tags": [], + "id": "def-server.EnvironmentMode.prod", + "type": "boolean", + "label": "prod", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L17" + } + } + ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PackageInfo", + "type": "Interface", + "label": "PackageInfo", + "signature": [ + "PackageInfo" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.PackageInfo.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 5, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L5" + } + }, + { + "tags": [], + "id": "def-server.PackageInfo.branch", + "type": "string", + "label": "branch", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 6, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L6" + } + }, + { + "tags": [], + "id": "def-server.PackageInfo.buildNum", + "type": "number", + "label": "buildNum", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 7, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L7" + } + }, + { + "tags": [], + "id": "def-server.PackageInfo.buildSha", + "type": "string", + "label": "buildSha", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L8" + } + }, + { + "tags": [], + "id": "def-server.PackageInfo.dist", + "type": "boolean", + "label": "dist", + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L9" + } + } + ], + "source": { + "path": "node_modules/@kbn/config/target/types.d.ts", + "lineNumber": 4, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L4" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IContextContainer", + "type": "Interface", + "label": "IContextContainer", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + }, + "" + ], + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" + ], + "tags": [ + "remarks", + "typeParam", + "public" + ], + "children": [ + { + "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": [ + { + "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": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L154" + } + }, + { + "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": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L155" + } + }, + { + "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": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L156" + } + } + ], + "tags": [ + "remarks" + ], + "returnComment": [ + "The {@link IContextContainer} for method chaining." + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L153" + } + }, + { + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "label": "createHandler", + "signature": [ + "(pluginOpaqueId: symbol, handler: THandler) => (...rest: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HandlerParameters", + "text": "HandlerParameters" + }, + ") => ", + "ShallowPromise", + ">" + ], + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" + ], + "children": [ + { + "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": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L168" + } + }, + { + "type": "Function", + "label": "handler", + "isRequired": true, + "signature": [ + "THandler" + ], + "description": [ + "- Handler function to pass context object to." + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L169" + } + } + ], + "tags": [], + "returnComment": [ + "A function that takes `THandlerParameters`, 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": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L167" + } + } + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L138" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L21" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ICspConfig.strict", + "type": "boolean", + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L27" + } + }, + { + "tags": [], + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L33" + } + }, + { + "tags": [], + "id": "def-server.ICspConfig.header", + "type": "string", + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L39" + } + } + ], + "source": { + "path": "src/core/server/csp/csp_config.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyElasticsearchError", + "type": "Interface", + "label": "LegacyElasticsearchError", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyElasticsearchError", + "text": "LegacyElasticsearchError" + }, + " extends ", + "Boom", + "" + ], + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.LegacyElasticsearchError.[code]", + "type": "string", + "label": "[code]", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L23" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/errors.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchServiceSetup", + "type": "Interface", + "label": "ElasticsearchServiceSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "deprecated" + ], + "id": "def-server.ElasticsearchServiceSetup.legacy", + "type": "Object", + "label": "legacy", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L30" + }, + "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<", + { + "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": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchServiceStart", + "type": "Interface", + "label": "ElasticsearchServiceStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "example" + ], + "id": "def-server.ElasticsearchServiceStart.client", + "type": "Object", + "label": "client", + "description": [ + "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L96" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.ElasticsearchServiceStart.createClient", + "type": "Function", + "label": "createClient", + "description": [ + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L114" + }, + "signature": [ + "(type: string, clientConfig?: Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L124" + }, + "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<", + { + "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": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L87" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchStatusMeta", + "type": "Interface", + "label": "ElasticsearchStatusMeta", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ElasticsearchStatusMeta.warningNodes", + "type": "Array", + "label": "warningNodes", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L172" + }, + "signature": [ + "NodeInfo[]" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", + "type": "Array", + "label": "incompatibleNodes", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L173" + }, + "signature": [ + "NodeInfo[]" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L171" + }, + "initialIsOpen": false + }, + { + "id": "def-server.NodesVersionCompatibility", + "type": "Interface", + "label": "NodesVersionCompatibility", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.NodesVersionCompatibility.isCompatible", + "type": "boolean", + "label": "isCompatible", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L47" + } + }, + { + "tags": [], + "id": "def-server.NodesVersionCompatibility.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L48" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.NodesVersionCompatibility.incompatibleNodes", + "type": "Array", + "label": "incompatibleNodes", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L49" + }, + "signature": [ + "NodeInfo[]" + ] + }, + { + "tags": [], + "id": "def-server.NodesVersionCompatibility.warningNodes", + "type": "Array", + "label": "warningNodes", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L50" + }, + "signature": [ + "NodeInfo[]" + ] + }, + { + "tags": [], + "id": "def-server.NodesVersionCompatibility.kibanaVersion", + "type": "string", + "label": "kibanaVersion", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L51" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyAPICaller", + "type": "Interface", + "label": "LegacyAPICaller", + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L164" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L165" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L166" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L167" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L168" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L169" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L170" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L171" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L172" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L173" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L174" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L176" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L177" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L178" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L179" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L181" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L182" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L184" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L185" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L186" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L187" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L188" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L189" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L190" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 191, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L191" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L192" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L193" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 195, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L195" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L196" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L197" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L198" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L199" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L200" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 201, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L201" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L202" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L205" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L206" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L207" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L208" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L209" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L210" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L211" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L212" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L213" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L214" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L215" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L216" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L217" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L218" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L219" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L220" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L221" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L222" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L223" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L226" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L227" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L228" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L229" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L230" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L231" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L232" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L233" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L236" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L237" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L238" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L239" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L240" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L241" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L242" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L243" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L244" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L245" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L246" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L247" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L248" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 249, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L249" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L250" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L251" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L252" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L253" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L254" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L255" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L256" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L257" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 258, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L258" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L259" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L260" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L261" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L262" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 263, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L263" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L264" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 265, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L265" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L266" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L267" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L268" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L269" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L270" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 271, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L271" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 274, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L274" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 275, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L275" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 276, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L276" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L277" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 280, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L280" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L281" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L282" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L285" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L286" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 287, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L287" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 288, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L288" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L289" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 290, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L290" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 291, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L291" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L292" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L293" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 296, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L296" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L297" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L298" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L301" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L304" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 309, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L309" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L162" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FakeRequest", + "type": "Interface", + "label": "FakeRequest", + "description": [ + "\nFake request object created manually by Kibana plugins." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.FakeRequest.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L182" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L180" + }, + "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": [ + { + "tags": [], + "id": "def-server.IClusterClient.asInternalUser", + "type": "CompoundType", + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L33" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ] + }, + { + "tags": [], + "id": "def-server.IClusterClient.asScoped", + "type": "Function", + "label": "asScoped", + "description": [ + "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L37" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ICustomClusterClient", + "type": "Interface", + "label": "ICustomClusterClient", + "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" + } + ], + "description": [ + "\nSee {@link IClusterClient}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L50" + }, + "signature": [ + "() => Promise" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L45" + }, + "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": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L24" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L29" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SearchResponse", + "type": "Interface", + "label": "SearchResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.SearchResponse", + "text": "SearchResponse" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SearchResponse.took", + "type": "number", + "label": "took", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L80" + } + }, + { + "tags": [], + "id": "def-server.SearchResponse.timed_out", + "type": "boolean", + "label": "timed_out", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L81" + } + }, + { + "tags": [], + "id": "def-server.SearchResponse._scroll_id", + "type": "string", + "label": "_scroll_id", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L82" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SearchResponse._shards", + "type": "Object", + "label": "_shards", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L83" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsResponse", + "text": "ShardsResponse" + } + ] + }, + { + "tags": [], + "id": "def-server.SearchResponse.hits", + "type": "Object", + "label": "hits", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L84" + }, + "signature": [ + "{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Explanation", + "text": "Explanation" + }, + " | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }" + ] + }, + { + "tags": [], + "id": "def-server.SearchResponse.aggregations", + "type": "Any", + "label": "aggregations", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L102" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.SearchResponse.pit_id", + "type": "string", + "label": "pit_id", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L103" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L79" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CountResponse", + "type": "Interface", + "label": "CountResponse", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.CountResponse._shards", + "type": "Object", + "label": "_shards", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L72" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsInfo", + "text": "ShardsInfo" + } + ] + }, + { + "tags": [], + "id": "def-server.CountResponse.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L73" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L71" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ShardsInfo", + "type": "Interface", + "label": "ShardsInfo", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ShardsInfo.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L62" + } + }, + { + "tags": [], + "id": "def-server.ShardsInfo.successful", + "type": "number", + "label": "successful", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L63" + } + }, + { + "tags": [], + "id": "def-server.ShardsInfo.skipped", + "type": "number", + "label": "skipped", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L64" + } + }, + { + "tags": [], + "id": "def-server.ShardsInfo.failed", + "type": "number", + "label": "failed", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L65" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ShardsResponse", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.ShardsResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L43" + } + }, + { + "tags": [], + "id": "def-server.ShardsResponse.successful", + "type": "number", + "label": "successful", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L44" + } + }, + { + "tags": [], + "id": "def-server.ShardsResponse.failed", + "type": "number", + "label": "failed", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L45" + } + }, + { + "tags": [], + "id": "def-server.ShardsResponse.skipped", + "type": "number", + "label": "skipped", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L46" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Explanation", + "type": "Interface", + "label": "Explanation", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.Explanation.value", + "type": "number", + "label": "value", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L53" + } + }, + { + "tags": [], + "id": "def-server.Explanation.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L54" + } + }, + { + "tags": [], + "id": "def-server.Explanation.details", + "type": "Array", + "label": "details", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L55" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Explanation", + "text": "Explanation" + }, + "[]" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GetResponse", + "type": "Interface", + "label": "GetResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetResponse", + "text": "GetResponse" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GetResponse._index", + "type": "string", + "label": "_index", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L110" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._type", + "type": "string", + "label": "_type", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L111" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._id", + "type": "string", + "label": "_id", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L112" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._version", + "type": "number", + "label": "_version", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L113" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._routing", + "type": "string", + "label": "_routing", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L114" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.GetResponse.found", + "type": "boolean", + "label": "found", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L115" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._source", + "type": "Uncategorized", + "label": "_source", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L116" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-server.GetResponse._seq_no", + "type": "number", + "label": "_seq_no", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L117" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._primary_term", + "type": "number", + "label": "_primary_term", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L118" + } + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L109" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DeleteDocumentResponse", + "type": "Interface", + "label": "DeleteDocumentResponse", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._shards", + "type": "Object", + "label": "_shards", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L125" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsResponse", + "text": "ShardsResponse" + } + ] + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse.found", + "type": "boolean", + "label": "found", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L126" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._index", + "type": "string", + "label": "_index", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L127" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._type", + "type": "string", + "label": "_type", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L128" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._id", + "type": "string", + "label": "_id", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L129" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._version", + "type": "number", + "label": "_version", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L130" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse.result", + "type": "string", + "label": "result", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L131" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L132" + }, + "signature": [ + "{ type: string; } | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L124" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IExternalUrlConfig", + "type": "Interface", + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "tags": [ + "public" + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L22" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L18" + }, + "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": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L33" + } + }, + { + "tags": [ + "example" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L46" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L59" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/external_url/external_url_config.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpResourcesRenderOptions", + "type": "Interface", + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "remarks" + ], + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "\nHTTP Headers with additional information about response." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L30" + }, + "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_resources/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpResourcesServiceToolkit", + "type": "Interface", + "label": "HttpResourcesServiceToolkit", + "description": [ + "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", + "type": "Function", + "label": "renderCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L45" + }, + "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." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L47" + }, + "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.renderHtml", + "type": "Function", + "label": "renderHtml", + "description": [ + "To respond with a custom HTML page." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L49" + }, + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", + "label": "renderJs", + "description": [ + "To respond with a custom JS script file." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L51" + }, + "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/http_resources/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IRenderOptions", + "type": "Interface", + "label": "IRenderOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "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": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/rendering/types.ts#L72" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/rendering/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/rendering/types.ts#L67" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Logger", + "type": "Interface", + "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" + ], + "children": [ + { + "id": "def-server.Logger.trace", + "type": "Function", + "label": "trace", + "signature": [ + "(message: string, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLog messages at the most detailed log level\n" + ], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The log message" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23" + } + }, + { + "id": "def-server.Logger.debug", + "type": "Function", + "label": "debug", + "signature": [ + "(message: string, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLog messages useful for debugging and interactive investigation" + ], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The log message" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29" + } + }, + { + "id": "def-server.Logger.info", + "type": "Function", + "label": "info", + "signature": [ + "(message: string, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLogs messages related to general application flow" + ], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The log message" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35" + } + }, + { + "id": "def-server.Logger.warn", + "type": "Function", + "label": "warn", + "signature": [ + "(errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLogs abnormal or unexpected errors or messages" + ], + "children": [ + { + "type": "CompoundType", + "label": "errorOrMessage", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [ + "- An Error object or message string to log" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41" + } + }, + { + "id": "def-server.Logger.error", + "type": "Function", + "label": "error", + "signature": [ + "(errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "errorOrMessage", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [ + "- An Error object or message string to log" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48" + } + }, + { + "id": "def-server.Logger.fatal", + "type": "Function", + "label": "fatal", + "signature": [ + "(errorOrMessage: string | Error, meta?: ", + "LogMeta", + " | undefined) => void" + ], + "description": [ + "\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "errorOrMessage", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [ + "- An Error object or message string to log" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55" + } + }, + { + "type": "Object", + "label": "meta", + "isRequired": false, + "signature": [ + "LogMeta", + " | undefined" + ], + "description": [ + "-" + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55" + } + }, + { + "id": "def-server.Logger.get", + "type": "Function", + "label": "get", + "signature": [ + "(...childContextPaths: string[]) => ", + "Logger" + ], + "description": [ + "\nReturns a new {@link Logger} instance extending the current logger context.\n" + ], + "children": [ + { + "type": "Array", + "label": "childContextPaths", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L67" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L67" + } + } + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LoggerFactory", + "type": "Interface", + "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" + ], + "children": [ + { + "id": "def-server.LoggerFactory.get", + "type": "Function", + "label": "get", + "signature": [ + "(...contextParts: string[]) => ", + "Logger" + ], + "description": [ + "\nReturns a `Logger` instance for the specified context.\n" + ], + "children": [ + { + "type": "Array", + "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." + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L15" + } + } + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger_factory.d.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L8" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L8" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "node_modules/@kbn/logging/target/logger.d.ts", + "lineNumber": 7, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L7" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LoggingServiceSetup", + "type": "Interface", + "label": "LoggingServiceSetup", + "description": [ + "\nProvides APIs to plugins for customizing the plugin's logger." + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.LoggingServiceSetup.configure", + "type": "Function", + "label": "configure", + "signature": [ + "(config$: ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LoggerContextConfigInput", + "text": "LoggerContextConfigInput" + }, + ">) => void" + ], + "description": [ + "\nCustomizes the logging config for the plugin's context.\n" + ], + "children": [ + { + "type": "Object", + "label": "config$", + "isRequired": true, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LoggerContextConfigInput", + "text": "LoggerContextConfigInput" + }, + ">" + ], + "description": [], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L41" + } + } + ], + "tags": [ + "remarks", + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L41" + } + } + ], + "source": { + "path": "src/core/server/logging/logging_service.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LoggerContextConfigInput", + "type": "Interface", + "label": "LoggerContextConfigInput", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.LoggerContextConfigInput.appenders", + "type": "CompoundType", + "label": "appenders", + "description": [], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L111" + }, + "signature": [ + "Record | Map | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LoggerContextConfigInput.loggers", + "type": "Array", + "label": "loggers", + "description": [], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L112" + }, + "signature": [ + "Readonly<{} & { name: string; level: ", + "LogLevelId", + "; appenders: string[]; }>[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L109" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DiscoveredPlugin", + "type": "Interface", + "label": "DiscoveredPlugin", + "description": [ + "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.DiscoveredPlugin.id", + "type": "string", + "label": "id", + "description": [ + "\nIdentifier of the plugin." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L189" + } + }, + { + "tags": [], + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", + "label": "configPath", + "description": [ + "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L194" + }, + "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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L200" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [], + "id": "def-server.DiscoveredPlugin.optionalPlugins", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L207" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [ + "remarks" + ], + "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" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L219" + }, + "signature": [ + "readonly string[]" + ] + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L185" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Plugin", + "type": "Interface", + "label": "Plugin", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "" + ], + "description": [ + "\nThe interface that should be returned by a `PluginInitializer`.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.Plugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup" + ], + "description": [], + "children": [ + { + "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": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsSetup" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252" + } + }, + { + "id": "def-server.Plugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart" + ], + "description": [], + "children": [ + { + "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": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsStart" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253" + } + }, + { + "id": "def-server.Plugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "(() => void) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L254" + } + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L246" + }, + "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" + }, + ", plugins: TPluginsSetup) => TSetup | Promise" + ], + "description": [], + "children": [ + { + "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": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsSetup" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269" + } + }, + { + "id": "def-server.AsyncPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart | Promise" + ], + "description": [], + "children": [ + { + "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": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270" + } + }, + { + "type": "Uncategorized", + "label": "plugins", + "isRequired": true, + "signature": [ + "TPluginsStart" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270" + } + }, + { + "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": 271, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L271" + } + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 263, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L263" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginConfigDescriptor", + "type": "Interface", + "label": "PluginConfigDescriptor", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginConfigDescriptor", + "text": "PluginConfigDescriptor" + }, + "" + ], + "description": [ + "\nDescribes a plugin configuration properties.\n" + ], + "tags": [ + "example", + "kbn", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.PluginConfigDescriptor.deprecations", + "type": "Function", + "label": "deprecations", + "description": [ + "\nProvider for the {@link ConfigDeprecation} to apply to the plugin configuration." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L62" + }, + "signature": [ + "ConfigDeprecationProvider", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.PluginConfigDescriptor.exposeToBrowser", + "type": "Object", + "label": "exposeToBrowser", + "description": [ + "\nList of configuration properties that will be available on the client-side plugin." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L66" + }, + "signature": [ + "{ [P in keyof T]?: boolean | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.PluginConfigDescriptor.schema", + "type": "Object", + "label": "schema", + "description": [ + "\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L72" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginConfigSchema", + "text": "PluginConfigSchema" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginInitializerContext", + "type": "Interface", + "label": "PluginInitializerContext", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [ + "\nContext that's available to plugins during initialization stage.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.PluginInitializerContext.opaqueId", + "type": "Uncategorized", + "label": "opaqueId", + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L298" + }, + "signature": [ + "symbol" + ] + }, + { + "tags": [], + "id": "def-server.PluginInitializerContext.env", + "type": "Object", + "label": "env", + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L299" + }, + "signature": [ + "{ mode: ", + "EnvironmentMode", + "; packageInfo: Readonly<", + "PackageInfo", + ">; instanceUuid: string; }" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.PluginInitializerContext.logger", + "type": "Object", + "label": "logger", + "description": [ + "\n{@link LoggerFactory | logger factory} instance already bound to the plugin's logging context\n" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 322, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L322" + }, + "signature": [ + "LoggerFactory" + ] + }, + { + "tags": [], + "id": "def-server.PluginInitializerContext.config", + "type": "Object", + "label": "config", + "description": [ + "\nAccessors for the plugin's configuration" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 326, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L326" + }, + "signature": [ + "{ legacy: { globalConfig$: ", + "Observable", + " 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", + ") => boolean; isLessThan: (other: ", + "ByteSizeValue", + ") => boolean; isEqualTo: (other: ", + "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": 297, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L297" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginManifest", + "type": "Interface", + "label": "PluginManifest", + "description": [ + "\nDescribes the set of required and optional properties plugin can define in its\nmandatory JSON manifest file.\n" + ], + "tags": [ + "remarks", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.PluginManifest.id", + "type": "string", + "label": "id", + "description": [ + "\nIdentifier of the plugin. Must be a string in camelCase. Part of a plugin public contract.\nOther plugins leverage it to access plugin API, navigate to the plugin, etc." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L107" + } + }, + { + "tags": [], + "id": "def-server.PluginManifest.version", + "type": "string", + "label": "version", + "description": [ + "\nVersion of the plugin." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L112" + } + }, + { + "tags": [], + "id": "def-server.PluginManifest.kibanaVersion", + "type": "string", + "label": "kibanaVersion", + "description": [ + "\nThe version of Kibana the plugin is compatible with, defaults to \"version\"." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L117" + } + }, + { + "tags": [ + "example" + ], + "id": "def-server.PluginManifest.configPath", + "type": "CompoundType", + "label": "configPath", + "description": [ + "\nRoot {@link ConfigPath | configuration path} used by the plugin, defaults\nto \"id\" in snake_case format.\n" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L127" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-server.PluginManifest.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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L133" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.PluginManifest.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" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L145" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [], + "id": "def-server.PluginManifest.optionalPlugins", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L152" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [], + "id": "def-server.PluginManifest.ui", + "type": "boolean", + "label": "ui", + "description": [ + "\nSpecifies whether plugin includes some client/browser specific functionality\nthat should be included into client bundle via `public/ui_plugin.js` file." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L158" + } + }, + { + "tags": [], + "id": "def-server.PluginManifest.server", + "type": "boolean", + "label": "server", + "description": [ + "\nSpecifies whether plugin includes some server-side specific functionality." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L163" + } + }, + { + "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" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L171" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.PluginManifest.serviceFolders", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L177" + }, + "signature": [ + "readonly string[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L102" + }, + "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": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L35" + }, + "signature": [ + "() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\">>>" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L39" + }, + "signature": [ + "(key: string) => Promise" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L43" + }, + "signature": [ + "() => Promise>" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L47" + }, + "signature": [ + "() => Promise>>" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L51" + }, + "signature": [ + "(changes: Record) => Promise" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L55" + }, + "signature": [ + "(key: string, value: any) => Promise" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L59" + }, + "signature": [ + "(key: string) => Promise" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L63" + }, + "signature": [ + "(keys: string[]) => Promise" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L67" + }, + "signature": [ + "(key: string) => boolean" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L71" + }, + "signature": [ + "(key: string) => boolean" + ] + } + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-server.UiSettingsParams", + "type": "Interface", + "label": "UiSettingsParams", + "signature": [ + "UiSettingsParams", + "" + ], + "description": [ + "\nUiSettings parameters defined by the plugins." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.UiSettingsParams.name", + "type": "string", + "label": "name", + "description": [ + "title in the UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.value", + "type": "Uncategorized", + "label": "value", + "description": [ + "default value to fall back to if a user doesn't provide any" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L47" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.description", + "type": "string", + "label": "description", + "description": [ + "description provided to a user in UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L49" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.category", + "type": "Array", + "label": "category", + "description": [ + "used to group the configured setting in the UI" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L51" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.options", + "type": "Array", + "label": "options", + "description": [ + "array of permitted values for this setting" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L53" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.optionLabels", + "type": "Object", + "label": "optionLabels", + "description": [ + "text labels for 'select' type UI element" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L55" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.requiresPageReload", + "type": "CompoundType", + "label": "requiresPageReload", + "description": [ + "a flag indicating whether new value applying requires page reloading" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L57" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.readonly", + "type": "CompoundType", + "label": "readonly", + "description": [ + "a flag indicating that value cannot be changed" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L59" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.sensitive", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.type", + "type": "CompoundType", + "label": "type", + "description": [ + "defines a type of UI element {@link UiSettingsType}" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L66" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.deprecation", + "type": "Object", + "label": "deprecation", + "description": [ + "optional deprecation information. Used to generate a deprecation warning." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L68" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.DeprecationSettings", + "text": "DeprecationSettings" + }, + " | undefined" + ] + }, + { + "tags": [ + "remark" + ], + "id": "def-server.UiSettingsParams.order", + "type": "number", + "label": "order", + "description": [ + "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L75" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.validation", + "type": "CompoundType", + "label": "validation", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L81" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.ImageValidation", + "text": "ImageValidation" + }, + " | ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.StringValidationRegex", + "text": "StringValidationRegex" + }, + " | ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.StringValidationRegexString", + "text": "StringValidationRegexString" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UiSettingsParams.schema", + "type": "Object", + "label": "schema", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L86" + }, + "signature": [ + "Type", + "" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L92" + }, + "signature": [ + "{ type: ", + "UiCounterMetricType", + "; name: string; } | undefined" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-server.UiSettingsServiceSetup", + "type": "Interface", + "label": "UiSettingsServiceSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.UiSettingsServiceSetup.register", + "type": "Function", + "label": "register", + "signature": [ + "(settings: Record>) => void" + ], + "description": [ + "\nSets settings with default values for the uiSettings." + ], + "children": [ + { + "type": "Object", + "label": "settings", + "isRequired": true, + "signature": [ + "Record>" + ], + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L102" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L102" + } + } + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L84" + }, + "initialIsOpen": false + }, + { + "id": "def-server.UiSettingsServiceStart", + "type": "Interface", + "label": "UiSettingsServiceStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.UiSettingsServiceStart.asScopedToClient", + "type": "Function", + "label": "asScopedToClient", + "signature": [ + "(savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "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" + ], + "children": [ + { + "type": "Object", + "label": "savedObjectsClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "description": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L121" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L121" + } + } + ], + "source": { + "path": "src/core/server/ui_settings/types.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L106" + }, + "initialIsOpen": false + }, + { + "id": "def-server.UserProvidedValues", + "type": "Interface", + "label": "UserProvidedValues", + "signature": [ + "UserProvidedValues", + "" + ], + "description": [ + "\nDescribes the values explicitly set by user." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.UserProvidedValues.userValue", + "type": "Uncategorized", + "label": "userValue", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L143" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-server.UserProvidedValues.isOverridden", + "type": "CompoundType", + "label": "isOverridden", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L144" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L142" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ImageValidation", + "type": "Interface", + "label": "ImageValidation", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ImageValidation.maxSize", + "type": "Object", + "label": "maxSize", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L132" + }, + "signature": [ + "{ length: number; description: string; }" + ] + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L131" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DeprecationSettings", + "type": "Interface", + "label": "DeprecationSettings", + "description": [ + "\nUiSettings deprecation field options." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.DeprecationSettings.message", + "type": "string", + "label": "message", + "description": [ + "Deprecation message" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L34" + } + }, + { + "tags": [], + "id": "def-server.DeprecationSettings.docLinksKey", + "type": "string", + "label": "docLinksKey", + "description": [ + "Key to documentation links" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L36" + } + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-server.StringValidationRegex", + "type": "Interface", + "label": "StringValidationRegex", + "description": [ + "\nStringValidation with regex object" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.StringValidationRegex.regex", + "type": "Object", + "label": "regex", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L115" + }, + "signature": [ + "RegExp" + ] + }, + { + "tags": [], + "id": "def-server.StringValidationRegex.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L116" + } + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L114" + }, + "initialIsOpen": false + }, + { + "id": "def-server.StringValidationRegexString", + "type": "Interface", + "label": "StringValidationRegexString", + "description": [ + "\nStringValidation as regex string" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.StringValidationRegexString.regexString", + "type": "string", + "label": "regexString", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L124" + } + }, + { + "tags": [], + "id": "def-server.StringValidationRegexString.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L125" + } + } + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L123" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OpsMetrics", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.OpsMetrics.collected_at", + "type": "Object", + "label": "collected_at", + "description": [ + "Time metrics were recorded at." + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L53" + }, + "signature": [ + "Date" + ] + }, + { + "tags": [], + "id": "def-server.OpsMetrics.process", + "type": "Object", + "label": "process", + "description": [ + "Process related metrics" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L55" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.OpsProcessMetrics", + "text": "OpsProcessMetrics" + } + ] + }, + { + "tags": [], + "id": "def-server.OpsMetrics.os", + "type": "Object", + "label": "os", + "description": [ + "OS related metrics" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L57" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.OpsOsMetrics", + "text": "OpsOsMetrics" + } + ] + }, + { + "tags": [], + "id": "def-server.OpsMetrics.response_times", + "type": "Object", + "label": "response_times", + "description": [ + "server response time stats" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L59" + }, + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsMetrics.requests", + "type": "Object", + "label": "requests", + "description": [ + "server requests stats" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L61" + }, + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsMetrics.concurrent_connections", + "type": "number", + "label": "concurrent_connections", + "description": [ + "number of current concurrent connections to the server" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L63" + } + } + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L51" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OpsOsMetrics", + "type": "Interface", + "label": "OpsOsMetrics", + "description": [ + "\nOS related metrics" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OpsOsMetrics.platform", + "type": "CompoundType", + "label": "platform", + "description": [ + "The os platform" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L50" + }, + "signature": [ + "NodeJS.Platform" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.platformRelease", + "type": "string", + "label": "platformRelease", + "description": [ + "The os platform release, prefixed by the platform name" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L52" + } + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.distro", + "type": "string", + "label": "distro", + "description": [ + "The os distrib. Only present for linux platforms" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.distroRelease", + "type": "string", + "label": "distroRelease", + "description": [ + "The os distrib release, prefixed by the os distrib. Only present for linux platforms" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L56" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.load", + "type": "Object", + "label": "load", + "description": [ + "cpu load metrics" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L58" + }, + "signature": [ + "{ '1m': number; '5m': number; '15m': number; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.memory", + "type": "Object", + "label": "memory", + "description": [ + "system memory usage metrics" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L67" + }, + "signature": [ + "{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.uptime_in_millis", + "type": "number", + "label": "uptime_in_millis", + "description": [ + "the OS uptime" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L76" + } + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.cpuacct", + "type": "Object", + "label": "cpuacct", + "description": [ + "cpu accounting metrics, undefined when not running in a cgroup" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L79" + }, + "signature": [ + "{ control_group: string; usage_nanos: number; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.OpsOsMetrics.cpu", + "type": "Object", + "label": "cpu", + "description": [ + "cpu cgroup metrics, undefined when not running in a cgroup" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L87" + }, + "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": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OpsServerMetrics", + "type": "Interface", + "label": "OpsServerMetrics", + "description": [ + "\nserver related metrics" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OpsServerMetrics.response_times", + "type": "Object", + "label": "response_times", + "description": [ + "server response time stats" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L112" + }, + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsServerMetrics.requests", + "type": "Object", + "label": "requests", + "description": [ + "server requests stats" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L119" + }, + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsServerMetrics.concurrent_connections", + "type": "number", + "label": "concurrent_connections", + "description": [ + "number of current concurrent connections to the server" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L128" + } + } + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L110" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OpsProcessMetrics", + "type": "Interface", + "label": "OpsProcessMetrics", + "description": [ + "\nProcess related metrics" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OpsProcessMetrics.memory", + "type": "Object", + "label": "memory", + "description": [ + "process memory usage" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L23" + }, + "signature": [ + "{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }" + ] + }, + { + "tags": [], + "id": "def-server.OpsProcessMetrics.event_loop_delay", + "type": "number", + "label": "event_loop_delay", + "description": [ + "node event loop delay" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-server.OpsProcessMetrics.pid", + "type": "number", + "label": "pid", + "description": [ + "pid of the kibana process" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L39" + } + }, + { + "tags": [], + "id": "def-server.OpsProcessMetrics.uptime_in_millis", + "type": "number", + "label": "uptime_in_millis", + "description": [ + "uptime of the kibana process" + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L41" + } + } + ], + "source": { + "path": "src/core/server/metrics/collectors/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-server.MetricsServiceSetup", + "type": "Interface", + "label": "MetricsServiceSetup", + "description": [ + "\nAPIs to retrieves metrics gathered and exposed by the core platform.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.MetricsServiceSetup.collectionInterval", + "type": "number", + "label": "collectionInterval", + "description": [ + "Interval metrics are collected in milliseconds" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L19" + } + }, + { + "tags": [ + "example" + ], + "id": "def-server.MetricsServiceSetup.getOpsMetrics$", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L33" + }, + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.OpsMetrics", + "text": "OpsMetrics" + }, + ">" + ] + } + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.I18nServiceSetup", + "type": "Interface", + "label": "I18nServiceSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.I18nServiceSetup.getLocale", + "type": "Function", + "label": "getLocale", + "signature": [ + "() => string" + ], + "description": [ + "\nReturn the locale currently in use." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L31" + } + }, + { + "id": "def-server.I18nServiceSetup.getTranslationFiles", + "type": "Function", + "label": "getTranslationFiles", + "signature": [ + "() => string[]" + ], + "description": [ + "\nReturn the absolute paths to translation files currently in use." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L36" + } + } + ], + "source": { + "path": "src/core/server/i18n/i18n_service.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L27" + }, + "initialIsOpen": false + }, + { + "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", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/types/app_category.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObject", + "type": "Interface", + "label": "SavedObject", + "signature": [ + "SavedObject", + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObject.id", + "type": "string", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" + } + }, + { + "tags": [], + "id": "def-server.SavedObject.type", + "type": "string", + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" + } + }, + { + "tags": [], + "id": "def-server.SavedObject.version", + "type": "string", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.updated_at", + "type": "string", + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.references", + "type": "Array", + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.originId", + "type": "string", + "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." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectAttributes", + "type": "Interface", + "label": "SavedObjectAttributes", + "description": [ + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.SavedObjectAttributes.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectReference", + "type": "Interface", + "label": "SavedObjectReference", + "description": [ + "\nA reference to another saved object.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectReference.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectReference.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectReference.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47" + } + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsMigrationVersion", + "type": "Interface", + "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": [ + "example", + "public" + ], + "children": [ + { + "id": "def-server.SavedObjectsMigrationVersion.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyServiceSetupDeps", + "type": "Interface", + "label": "LegacyServiceSetupDeps", + "description": [], + "tags": [ + "public", + "deprecated" + ], + "children": [ + { + "tags": [], + "id": "def-server.LegacyServiceSetupDeps.core", + "type": "CompoundType", + "label": "core", + "description": [], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L43" + }, + "signature": [ + "LegacyCoreSetup" + ] + }, + { + "tags": [], + "id": "def-server.LegacyServiceSetupDeps.plugins", + "type": "Object", + "label": "plugins", + "description": [], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L44" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.LegacyServiceSetupDeps.uiPlugins", + "type": "Object", + "label": "uiPlugins", + "description": [], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L45" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiPlugins", + "text": "UiPlugins" + } + ] + } + ], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyServiceStartDeps", + "type": "Interface", + "label": "LegacyServiceStartDeps", + "description": [], + "tags": [ + "public", + "deprecated" + ], + "children": [ + { + "tags": [], + "id": "def-server.LegacyServiceStartDeps.core", + "type": "CompoundType", + "label": "core", + "description": [], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L53" + }, + "signature": [ + "LegacyCoreStart" + ] + }, + { + "tags": [], + "id": "def-server.LegacyServiceStartDeps.plugins", + "type": "Object", + "label": "plugins", + "description": [], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L54" + }, + "signature": [ + "Record" + ] + } + ], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CoreStatus", + "type": "Interface", + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "tags": [ + "internalRemarks", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.CoreStatus.elasticsearch", + "type": "Object", + "label": "elasticsearch", + "description": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L115" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L116" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L114" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ServiceStatus", + "type": "Interface", + "label": "ServiceStatus", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "description": [ + "\nThe current status of a service at a point in time.\n" + ], + "tags": [ + "typeParam", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ServiceStatus.level", + "type": "CompoundType", + "label": "level", + "description": [ + "\nThe current availability level of the service." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L24" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatusLevel", + "text": "ServiceStatusLevel" + } + ] + }, + { + "tags": [], + "id": "def-server.ServiceStatus.summary", + "type": "string", + "label": "summary", + "description": [ + "\nA high-level summary of the service status." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L28" + } + }, + { + "tags": [], + "id": "def-server.ServiceStatus.detail", + "type": "string", + "label": "detail", + "description": [ + "\nA more detailed description of the service status." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ServiceStatus.documentationUrl", + "type": "string", + "label": "documentationUrl", + "description": [ + "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L36" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ServiceStatus.meta", + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L41" + }, + "signature": [ + "Meta | undefined" + ] + } + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.StatusServiceSetup", + "type": "Interface", + "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": [ + "remarks", + "example", + "example", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.StatusServiceSetup.core$", + "type": "Object", + "label": "core$", + "description": [ + "\nCurrent status for all Core services." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L181" + }, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStatus", + "text": "CoreStatus" + }, + ">" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.StatusServiceSetup.overall$", + "type": "Object", + "label": "overall$", + "description": [ + "\nOverall system status for all of Kibana.\n" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L192" + }, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" + ] + }, + { + "id": "def-server.StatusServiceSetup.set", + "type": "Function", + "label": "set", + "signature": [ + "(status$: ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">) => void" + ], + "description": [ + "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" + ], + "children": [ + { + "type": "Object", + "label": "status$", + "isRequired": true, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" + ], + "description": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" + } + } + ], + "tags": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" + } + }, + { + "tags": [], + "id": "def-server.StatusServiceSetup.dependencies$", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L208" + }, + "signature": [ + "Observable", + ">>" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.StatusServiceSetup.derivedStatus$", + "type": "Object", + "label": "derivedStatus$", + "description": [ + "\nThe status of this plugin as derived from its dependencies.\n" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L220" + }, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.StatusServiceSetup.isStatusPageAnonymous", + "type": "Function", + "label": "isStatusPageAnonymous", + "description": [ + "\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L226" + }, + "signature": [ + "() => boolean" + ] + } + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L177" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandlerContext", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.RequestHandlerContext.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 415, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L415" + }, + "signature": [ + "{ savedObjects: { client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; getClient: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; getExporter: (client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + } + ] + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L414" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CoreSetup", + "type": "Interface", + "label": "CoreSetup", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [ + "\nContext passed to the plugins `setup` method.\n" + ], + "tags": [ + "typeParam", + "typeParam", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.CoreSetup.capabilities", + "type": "Object", + "label": "capabilities", + "description": [ + "{@link CapabilitiesSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 449, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L449" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSetup", + "text": "CapabilitiesSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.context", + "type": "Object", + "label": "context", + "description": [ + "{@link ContextSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 451, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L451" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ContextSetup", + "text": "ContextSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.elasticsearch", + "type": "Object", + "label": "elasticsearch", + "description": [ + "{@link ElasticsearchServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 453, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L453" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceSetup", + "text": "ElasticsearchServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.http", + "type": "CompoundType", + "label": "http", + "description": [ + "{@link HttpServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 455, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L455" + }, + "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" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.i18n", + "type": "Object", + "label": "i18n", + "description": [ + "{@link I18nServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 460, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L460" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.I18nServiceSetup", + "text": "I18nServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.logging", + "type": "Object", + "label": "logging", + "description": [ + "{@link LoggingServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 462, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L462" + }, + "signature": [ + { + "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": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L464" + }, + "signature": [ + { + "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": 466, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L466" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceSetup", + "text": "SavedObjectsServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.status", + "type": "Object", + "label": "status", + "description": [ + "{@link StatusServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 468, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L468" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StatusServiceSetup", + "text": "StatusServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 470, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L470" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceSetup", + "text": "UiSettingsServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.getStartServices", + "type": "Function", + "label": "getStartServices", + "description": [ + "{@link StartServicesAccessor}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 472, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L472" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StartServicesAccessor", + "text": "StartServicesAccessor" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 447, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L447" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CoreStart", + "type": "Interface", + "label": "CoreStart", + "description": [ + "\nContext passed to the plugins `start` method.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.CoreStart.capabilities", + "type": "Object", + "label": "capabilities", + "description": [ + "{@link CapabilitiesStart}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 495, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L495" + }, + "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}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 497, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L497" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceStart", + "text": "ElasticsearchServiceStart" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreStart.http", + "type": "Object", + "label": "http", + "description": [ + "{@link HttpServiceStart}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 499, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L499" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServiceStart", + "text": "HttpServiceStart" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreStart.metrics", + "type": "Object", + "label": "metrics", + "description": [ + "{@link MetricsServiceStart}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 501, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L501" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreStart.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceStart}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 503, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L503" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreStart.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceStart}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 505, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L505" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceStart", + "text": "UiSettingsServiceStart" + } + ] + } + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 493, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L493" + }, + "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" + }, + ") => void" + ], + "description": [ + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" + } + }, + { + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", + "label": "registerSwitcher", + "signature": [ + "(switcher: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => 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": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" + } + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L30" + }, + "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" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.Capabilities", + "text": "Capabilities" + }, + ">" + ], + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L118" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L119" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L117" + } + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L113" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ContextSetup", + "type": "Interface", + "label": "ContextSetup", + "description": [ + "\n{@inheritdoc IContextContainer}\n" + ], + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L96" + } + } + ], + "source": { + "path": "src/core/server/context/context_service.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L92" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpResources", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpResources.register", + "type": "Function", + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L101" + }, + "signature": [ + "(route: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream" + ] + } + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L99" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyCallAPIOptions", + "type": "Interface", + "label": "LegacyCallAPIOptions", + "description": [ + "\nThe set of options that defines how API call should be made and result be\nprocessed.\n" + ], + "tags": [ + "public", + "deprecated" + ], + "children": [ + { + "tags": [], + "id": "def-server.LegacyCallAPIOptions.wrap401Errors", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L151" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LegacyCallAPIOptions.signal", + "type": "Object", + "label": "signal", + "description": [ + "\nA signal object that allows you to abort the request via an AbortController object." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L155" + }, + "signature": [ + "AbortSignal | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L144" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L318" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L319" + }, + "signature": [ + "\"GET\"" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L317" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L338" + }, + "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": 337, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L337" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DeprecationAPIClientParams", + "type": "Interface", + "label": "DeprecationAPIClientParams", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationAPIClientParams", + "text": "DeprecationAPIClientParams" + }, + " extends ", + "GenericParams" + ], + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.DeprecationAPIClientParams.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 350, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L350" + }, + "signature": [ + "\"/_migration/deprecations\"" + ] + }, + { + "tags": [], + "id": "def-server.DeprecationAPIClientParams.method", + "type": "string", + "label": "method", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 351, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L351" + }, + "signature": [ + "\"GET\"" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 349, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L349" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L359" + }, + "signature": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L360" + } + }, + { + "tags": [], + "id": "def-server.DeprecationInfo.url", + "type": "string", + "label": "url", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 361, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L361" + } + }, + { + "tags": [], + "id": "def-server.DeprecationInfo.details", + "type": "string", + "label": "details", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 362, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L362" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 358, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L358" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexSettingsDeprecationInfo", + "type": "Interface", + "label": "IndexSettingsDeprecationInfo", + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "id": "def-server.IndexSettingsDeprecationInfo.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 370, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L370" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L369" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DeprecationAPIResponse", + "type": "Interface", + "label": "DeprecationAPIResponse", + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L378" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.DeprecationAPIResponse.ml_settings", + "type": "Array", + "label": "ml_settings", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 379, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L379" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.DeprecationAPIResponse.node_settings", + "type": "Array", + "label": "node_settings", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 380, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L380" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L381" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L377" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.CapabilitiesProvider", + "type": "Type", + "label": "CapabilitiesProvider", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link CapabilitiesSetup}" + ], + "source": { + "path": "src/core/server/capabilities/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/types.ts#L18" + }, + "signature": [ + "() => Partial<", + "Capabilities", + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.CapabilitiesSwitcher", + "type": "Type", + "label": "CapabilitiesSwitcher", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link CapabilitiesSetup}" + ], + "source": { + "path": "src/core/server/capabilities/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/types.ts#L24" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", uiCapabilities: ", + "Capabilities", + ", useDefaultCapabilities: boolean) => Partial<", + "Capabilities", + "> | Promise>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ConfigPath", + "type": "Type", + "label": "ConfigPath", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "node_modules/@kbn/config/target/config.d.ts", + "lineNumber": 2, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config.d.ts#L2" + }, + "signature": [ + "string | string[]" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ConfigDeprecation", + "type": "Type", + "label": "ConfigDeprecation", + "tags": [ + "remarks", + "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": 16, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L16" + }, + "signature": [ + "(config: Record, fromPath: string, logger: ", + "ConfigDeprecationLogger", + ") => Record" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ConfigDeprecationProvider", + "type": "Type", + "label": "ConfigDeprecationProvider", + "tags": [ + "example", + "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": 33, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L33" + }, + "signature": [ + "(factory: ", + "ConfigDeprecationFactory", + ") => ", + "ConfigDeprecation", + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ConfigDeprecationLogger", + "type": "Type", + "label": "ConfigDeprecationLogger", + "tags": [ + "public" + ], + "description": [ + "\nLogger interface used when invoking a {@link ConfigDeprecation}\n" + ], + "source": { + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "lineNumber": 6, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L6" + }, + "signature": [ + "(message: string) => void" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IContextProvider", + "type": "Type", + "label": "IContextProvider", + "tags": [ + "remarks", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L27" + }, + "signature": [ + "(context: Pick>, rest: [request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | 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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.HandlerFunction", + "type": "Type", + "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" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L42" + }, + "signature": [ + "(context: T, args: any[]) => any" + ], + "initialIsOpen": false + }, + { + "id": "def-server.HandlerContextType", + "type": "Type", + "label": "HandlerContextType", + "tags": [ + "public" + ], + "description": [ + "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L49" + }, + "signature": [ + "T extends HandlerFunction ? U : never" + ], + "initialIsOpen": false + }, + { + "id": "def-server.HandlerParameters", + "type": "Type", + "label": "HandlerParameters", + "tags": [ + "public" + ], + "description": [ + "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + ], + "source": { + "path": "src/core/server/context/container/context.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L59" + }, + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ILegacyClusterClient", + "type": "Type", + "label": "ILegacyClusterClient", + "tags": [ + "deprecated", + "public" + ], + "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" + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L83" + }, + "signature": [ + "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | undefined) => Pick; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ILegacyCustomClusterClient", + "type": "Type", + "label": "ILegacyCustomClusterClient", + "tags": [ + "deprecated", + "public" + ], + "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}." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L94" + }, + "signature": [ + "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L24" + }, + "signature": [ + "{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.LegacyElasticsearchClientConfig", + "type": "Type", + "label": "LegacyElasticsearchClientConfig", + "tags": [ + "privateRemarks", + "deprecated", + "public" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/elasticsearch_client_config.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/elasticsearch_client_config.ts#L27" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ScopeableRequest", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L192" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchClient", + "type": "Type", + "label": "ElasticsearchClient", + "tags": [ + "public" + ], + "description": [ + "\nClient used to query the elasticsearch cluster.\n" + ], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L22" + }, + "signature": [ + "Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchClientConfig", + "type": "Type", + "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" + ], + "source": { + "path": "src/core/server/elasticsearch/client/client_config.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/client_config.ts#L22" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.HttpResourcesResponseOptions", + "type": "Type", + "label": "HttpResourcesResponseOptions", + "tags": [ + "public" + ], + "description": [ + "\nHTTP Resources response parameters" + ], + "source": { + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L37" + }, + "signature": [ + "HttpResponseOptions" + ], + "initialIsOpen": false + }, + { + "id": "def-server.HttpResourcesRequestHandler", + "type": "Type", + "label": "HttpResourcesRequestHandler", + "tags": [ + "link", + "link", + "link", + "libk", + "example", + "public" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L76" + }, + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | 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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.LoggerConfigType", + "type": "Type", + "label": "LoggerConfigType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/logging/logging_config.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L59" + }, + "signature": [ + "{ readonly name: string; readonly level: ", + "LogLevelId", + "; readonly appenders: string[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AppenderConfigType", + "type": "Type", + "label": "AppenderConfigType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/logging/appenders/appenders.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/appenders/appenders.ts#L41" + }, + "signature": [ + "ConsoleAppenderConfig", + " | ", + "FileAppenderConfig", + " | ", + "LegacyAppenderConfig", + " | ", + "RewriteAppenderConfig", + " | ", + "RollingFileAppenderConfig" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PluginConfigSchema", + "type": "Type", + "label": "PluginConfigSchema", + "tags": [ + "public" + ], + "description": [ + "\nDedicated type for plugin configuration schema.\n" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L26" + }, + "signature": [ + "Type" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PluginInitializer", + "type": "Type", + "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": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L404" + }, + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PluginName", + "type": "Type", + "label": "PluginName", + "tags": [ + "public" + ], + "description": [ + "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + ], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L81" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SharedGlobalConfig", + "type": "Type", + "label": "SharedGlobalConfig", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L285" + }, + "signature": [ + "{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ", + "Duration", + "; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: ", + "argThresholdOpts", + " | undefined): string; (argThresholds?: ", + "argThresholdOpts", + " | undefined): string; }; abs: () => ", + "Duration", + "; as: (units: ", + "unitOfTime" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PublicUiSettingsParams", + "type": "Type", + "label": "PublicUiSettingsParams", + "tags": [ + "public" + ], + "description": [ + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L102" + }, + "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; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.UiSettingsType", + "type": "Type", + "label": "UiSettingsType", + "tags": [ + "public" + ], + "description": [ + "\nUI element type to represent the settings." + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L16" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.StringValidation", + "type": "Type", + "label": "StringValidation", + "tags": [ + "public" + ], + "description": [ + "\nAllows regex objects or a regex string" + ], + "source": { + "path": "src/core/types/ui_settings.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L108" + }, + "signature": [ + "StringValidationRegex", + " | ", + "StringValidationRegexString" + ], + "initialIsOpen": false + }, + { + "id": "def-server.MetricsServiceStart", + "type": "Type", + "label": "MetricsServiceStart", + "tags": [ + "public" + ], + "description": [ + "\n{@inheritdoc MetricsServiceSetup}\n" + ], + "source": { + "path": "src/core/server/metrics/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L40" + }, + "signature": [ + "MetricsServiceSetup" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectAttribute", + "type": "Type", + "label": "SavedObjectAttribute", + "tags": [ + "public" + ], + "description": [ + "\nType definition for a Saved Object attribute value\n" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L27" + }, + "signature": [ + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectAttributeSingle", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L14" + }, + "signature": [ + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ServiceStatusLevel", + "type": "Type", + "label": "ServiceStatusLevel", + "tags": [ + "public" + ], + "description": [ + "\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L103" + }, + "signature": [ + "Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.StartServicesAccessor", + "type": "Type", + "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": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L483" + }, + "signature": [ + "() => Promise<[", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", TPluginsStart, TStart]>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PluginOpaqueId", + "type": "Type", + "label": "PluginOpaqueId", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/plugins/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L84" + }, + "signature": [ + "symbol" + ], + "initialIsOpen": false + }, + { + "id": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", + "type": "Type", + "label": "MIGRATION_ASSISTANCE_INDEX_ACTION", + "tags": [ + "deprecated", + "public" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 326, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L326" + }, + "signature": [ + "\"upgrade\" | \"reindex\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.MIGRATION_DEPRECATION_LEVEL", + "type": "Type", + "label": "MIGRATION_DEPRECATION_LEVEL", + "tags": [ + "deprecated", + "public" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L331" + }, + "signature": [ + "\"warning\" | \"none\" | \"info\" | \"critical\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [ + "remarks", + "public" + ], + "id": "def-server.ServiceStatusLevels", + "type": "Object", + "label": "ServiceStatusLevels", + "description": [ + "\nThe current \"level\" of availability of a service.\n" + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L56" + }, + "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\"; }>; }>" + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/core.mdx b/api_docs/core.mdx new file mode 100644 index 0000000000000..77050dd72894a --- /dev/null +++ b/api_docs/core.mdx @@ -0,0 +1,38 @@ +--- +id: kibCorePluginApi +slug: /kibana-dev-docs/corePluginApi +title: core +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import coreObj from './core.json'; + +## Client + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Objects + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/core_application.json b/api_docs/core_application.json new file mode 100644 index 0000000000000..17efa538b3122 --- /dev/null +++ b/api_docs/core_application.json @@ -0,0 +1,2007 @@ +{ + "id": "core.application", + "client": { + "classes": [ + { + "id": "def-public.ScopedHistory", + "type": "Class", + "tags": [ + "public" + ], + "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" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + " implements ", + "History", + "" + ], + "children": [ + { + "id": "def-public.ScopedHistory.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "parentHistory", + "isRequired": true, + "signature": [ + "History", + "" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59" + } + }, + { + "type": "string", + "label": "basePath", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59" + } + }, + { + "id": "def-public.ScopedHistory.createSubHistory", + "type": "Function", + "children": [ + { + "type": "string", + "label": "basePath", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L78" + } + } + ], + "signature": [ + "(basePath: string) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L77" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.length", + "type": "number", + "label": "length", + "tags": [], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L86" + } + }, + { + "id": "def-public.ScopedHistory.location", + "type": "Object", + "label": "location", + "tags": [], + "description": [ + "\nThe current location of the history stack." + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L94" + }, + "signature": [ + "Location", + "" + ] + }, + { + "id": "def-public.ScopedHistory.action", + "type": "CompoundType", + "label": "action", + "tags": [], + "description": [ + "\nThe last action dispatched on the history stack." + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L102" + }, + "signature": [ + "Action" + ] + }, + { + "id": "def-public.ScopedHistory.push", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "pathOrLocation", + "isRequired": true, + "signature": [ + "string | ", + "LocationDescriptorObject", + "" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L114" + } + }, + { + "type": "Uncategorized", + "label": "state", + "isRequired": false, + "signature": [ + "HistoryLocationState | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L115" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L113" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.replace", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "pathOrLocation", + "isRequired": true, + "signature": [ + "string | ", + "LocationDescriptorObject", + "" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L132" + } + }, + { + "type": "Uncategorized", + "label": "state", + "isRequired": false, + "signature": [ + "HistoryLocationState | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L133" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L131" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.go", + "type": "Function", + "children": [ + { + "type": "number", + "label": "n", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L150" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L150" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.goBack", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "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", + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L168" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.goForward", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "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", + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L177" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.block", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "prompt", + "isRequired": false, + "signature": [ + "string | boolean | ", + "History", + ".TransitionPromptHook | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L186" + } + } + ], + "signature": [ + "(prompt?: string | boolean | ", + "History", + ".TransitionPromptHook | undefined) => ", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L185" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ScopedHistory.listen", + "type": "Function", + "children": [ + { + "type": "Function", + "label": "listener", + "isRequired": true, + "signature": [ + "(location: ", + "Location", + ", action: ", + "Action", + ") => void" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L206" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L205" + }, + "tags": [], + "returnComment": [ + "an function to unsubscribe the listener." + ] + }, + { + "id": "def-public.ScopedHistory.createHref", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "location", + "isRequired": true, + "signature": [ + "LocationDescriptorObject", + "" + ], + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L223" + } + }, + { + "id": "def-public.ScopedHistory.createHref.{-prependBasePath = true }", + "type": "Object", + "label": "{ prependBasePath = true }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ScopedHistory.createHref.{-prependBasePath = true }.prependBasePath", + "type": "CompoundType", + "label": "prependBasePath", + "description": [], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L224" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L224" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L222" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/core/public/application/scoped_history.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L34" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.ApplicationSetup", + "type": "Interface", + "label": "ApplicationSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.ApplicationSetup.register", + "type": "Function", + "label": "register", + "signature": [ + "(app: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + ") => void" + ], + "description": [ + "\nRegister an mountable application to the system." + ], + "children": [ + { + "type": "Object", + "label": "app", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + "" + ], + "description": [ + "- an {@link App}" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 626, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L626" + } + } + ], + "tags": [ + "typeParam" + ], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 626, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L626" + } + }, + { + "id": "def-public.ApplicationSetup.registerAppUpdater", + "type": "Function", + "label": "registerAppUpdater", + "signature": [ + "(appUpdater$: ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUpdater", + "text": "AppUpdater" + }, + ">) => 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" + ], + "children": [ + { + "type": "Object", + "label": "appUpdater$", + "isRequired": true, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUpdater", + "text": "AppUpdater" + }, + ">" + ], + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 655, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L655" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 655, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L655" + } + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 620, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L620" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ApplicationStart", + "type": "Interface", + "label": "ApplicationStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ApplicationStart.capabilities", + "type": "Object", + "label": "capabilities", + "description": [ + "\nGets the read-only capabilities." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 695, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L695" + }, + "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; }>; }>" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-public.ApplicationStart.applications$", + "type": "Object", + "label": "applications$", + "description": [ + "\nObservable emitting the list of currently registered apps and their associated status.\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 704, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L704" + }, + "signature": [ + "Observable", + ">" + ] + }, + { + "id": "def-public.ApplicationStart.navigateToApp", + "type": "Function", + "label": "navigateToApp", + "signature": [ + "(appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nNavigate to a given app\n" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 712, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined" + ], + "description": [ + "- navigation options" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 712, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 712, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712" + } + }, + { + "id": "def-public.ApplicationStart.navigateToUrl", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "url", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- an absolute URL, an absolute path or a relative path, to navigate to." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 750, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L750" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 750, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L750" + } + }, + { + "id": "def-public.ApplicationStart.getUrlForApp", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764" + } + }, + { + "id": "def-public.ApplicationStart.getUrlForApp.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ApplicationStart.getUrlForApp.options.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ApplicationStart.getUrlForApp.options.absolute", + "type": "CompoundType", + "label": "absolute", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764" + } + }, + { + "tags": [], + "id": "def-public.ApplicationStart.currentAppId$", + "type": "Object", + "label": "currentAppId$", + "description": [ + "\nAn observable that emits the current application id and each subsequent id update." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 769, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L769" + }, + "signature": [ + "Observable", + "" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 691, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L691" + }, + "initialIsOpen": false + }, + { + "id": "def-public.App", + "type": "Interface", + "label": "App", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.App.id", + "type": "string", + "label": "id", + "description": [ + "\nThe unique identifier of the application" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L83" + } + }, + { + "tags": [], + "id": "def-public.App.title", + "type": "string", + "label": "title", + "description": [ + "\nThe title of the application." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L88" + } + }, + { + "tags": [], + "id": "def-public.App.category", + "type": "Object", + "label": "category", + "description": [ + "\nThe category definition of the product\nSee {@link AppCategory}\nSee DEFAULT_APP_CATEGORIES for more reference" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L95" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.status", + "type": "CompoundType", + "label": "status", + "description": [ + "\nThe initial status of the application.\nDefaulting to `accessible`" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L101" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppStatus", + "text": "AppStatus" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.navLinkStatus", + "type": "CompoundType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L108" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppNavLinkStatus", + "text": "AppNavLinkStatus" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.defaultPath", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L115" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.App.updater$", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L149" + }, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUpdater", + "text": "AppUpdater" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.order", + "type": "number", + "label": "order", + "description": [ + "\nAn ordinal used to sort nav links relative to one another for display." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L154" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.tooltip", + "type": "string", + "label": "tooltip", + "description": [ + "\nA tooltip shown when hovering over app link." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L159" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.euiIconType", + "type": "string", + "label": "euiIconType", + "description": [ + "\nA EUI iconType that will be used for the app's icon. This icon\ntakes precendence over the `icon` property." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L165" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.icon", + "type": "string", + "label": "icon", + "description": [ + "\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L171" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.capabilities", + "type": "Object", + "label": "capabilities", + "description": [ + "\nCustom capabilities defined by the app." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L176" + }, + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.Capabilities", + "text": "Capabilities" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.chromeless", + "type": "CompoundType", + "label": "chromeless", + "description": [ + "\nHide the UI chrome when the application is mounted. Defaults to `false`.\nTakes precedence over chrome service visibility settings." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L182" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.mount", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L187" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMount", + "text": "AppMount" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.App.appRoute", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L194" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.App.exactRoute", + "type": "CompoundType", + "label": "exactRoute", + "description": [ + "\nIf set to true, the application's route will only be checked against an exact match. Defaults to `false`.\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L212" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [ + "remarks", + "example" + ], + "id": "def-public.App.meta", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L244" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMeta", + "text": "AppMeta" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L79" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppMountParameters", + "type": "Interface", + "label": "AppMountParameters", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMountParameters", + "text": "AppMountParameters" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppMountParameters.element", + "type": "Object", + "label": "element", + "description": [ + "\nThe container element to render the application into." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 353, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L353" + }, + "signature": [ + "HTMLElement" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.AppMountParameters.history", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L399" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" + ] + }, + { + "tags": [ + "deprecated", + "example" + ], + "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" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 449, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L449" + } + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L484" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveHandler", + "text": "AppLeaveHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.AppMountParameters.setHeaderActionMenu", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L515" + }, + "signature": [ + "(menuMount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined) => void" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 349, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L349" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppLeaveDefaultAction", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppLeaveDefaultAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 554, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L554" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveActionType", + "text": "AppLeaveActionType" + }, + ".default" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 553, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L553" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppLeaveConfirmAction", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 566, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L566" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveActionType", + "text": "AppLeaveActionType" + }, + ".confirm" + ] + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 567, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L567" + } + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 568, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L568" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.callback", + "type": "Function", + "label": "callback", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 569, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L569" + }, + "signature": [ + "(() => void) | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 565, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L565" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppMeta", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppMeta.keywords", + "type": "Array", + "label": "keywords", + "description": [ + "Keywords to represent this application" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L257" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AppMeta.searchDeepLinks", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L259" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppSearchDeepLink", + "text": "AppSearchDeepLink" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L255" + }, + "initialIsOpen": false + }, + { + "id": "def-public.NavigateToAppOptions", + "type": "Interface", + "label": "NavigateToAppOptions", + "description": [ + "\nOptions for the {@link ApplicationStart.navigateToApp | navigateToApp API}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.NavigateToAppOptions.path", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 679, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L679" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.NavigateToAppOptions.state", + "type": "Unknown", + "label": "state", + "description": [ + "\noptional state to forward to the application" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 683, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L683" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-public.NavigateToAppOptions.replace", + "type": "CompoundType", + "label": "replace", + "description": [ + "\nif true, will not create a new history entry when navigating (using `replace` instead of `push`)" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 687, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L687" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 674, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L674" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.AppLeaveActionType", + "type": "Enum", + "label": "AppLeaveActionType", + "tags": [ + "public" + ], + "description": [ + "\nPossible type of actions on application leave.\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 540, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L540" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppStatus", + "type": "Enum", + "label": "AppStatus", + "tags": [ + "public" + ], + "description": [ + "\nAccessibility status of an application.\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AppNavLinkStatus", + "type": "Enum", + "label": "AppNavLinkStatus", + "tags": [ + "public" + ], + "description": [ + "\nStatus of the application's navLink.\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L40" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.AppMount", + "type": "Type", + "label": "AppMount", + "tags": [ + "link", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L338" + }, + "signature": [ + "(params: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMountParameters", + "text": "AppMountParameters" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUnmount", + "text": "AppUnmount" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppUnmount", + "text": "AppUnmount" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppUnmount", + "type": "Type", + "label": "AppUnmount", + "tags": [ + "public" + ], + "description": [ + "\nA function called when an application should be unmounted from the page. This function should be synchronous." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 346, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L346" + }, + "signature": [ + "() => void" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppLeaveHandler", + "type": "Type", + "label": "AppLeaveHandler", + "tags": [ + "public", + "deprecated" + ], + "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 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L530" + }, + "signature": [ + "(factory: ", + "AppLeaveActionFactory", + ", nextAppId: string | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveAction", + "text": "AppLeaveAction" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppLeaveAction", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L579" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveDefaultAction", + "text": "AppLeaveDefaultAction" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveConfirmAction", + "text": "AppLeaveConfirmAction" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppUpdatableFields", + "type": "Type", + "label": "AppUpdatableFields", + "tags": [ + "public" + ], + "description": [ + "\nDefines the list of fields that can be updated via an {@link AppUpdater}." + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L64" + }, + "signature": [ + "{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppUpdater", + "type": "Type", + "label": "AppUpdater", + "tags": [ + "public" + ], + "description": [ + "\nUpdater for applications.\nsee {@link ApplicationSetup}" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L74" + }, + "signature": [ + "(app: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + ") => Partial, \"status\" | \"meta\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\">> | undefined" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AppSearchDeepLink", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L293" + }, + "signature": [ + "{ id: string; title: string; } & { path: string; searchDeepLinks?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppSearchDeepLink", + "text": "AppSearchDeepLink" + }, + "[] | undefined; keywords?: string[] | undefined; } | { id: string; title: string; } & { path?: string | undefined; searchDeepLinks: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppSearchDeepLink", + "text": "AppSearchDeepLink" + }, + "[]; keywords?: string[] | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PublicAppInfo", + "type": "Type", + "label": "PublicAppInfo", + "tags": [ + "public" + ], + "description": [ + "\nPublic information about a registered {@link App | application}\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 322, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L322" + }, + "signature": [ + "Pick, \"status\" | \"id\" | \"title\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PublicAppMetaInfo", + "type": "Type", + "label": "PublicAppMetaInfo", + "tags": [ + "public" + ], + "description": [ + "\nPublic information about a registered app's {@link AppMeta | keywords }\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L267" + }, + "signature": [ + "Pick & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PublicAppSearchDeepLinkInfo", + "type": "Type", + "label": "PublicAppSearchDeepLinkInfo", + "tags": [ + "public" + ], + "description": [ + "\nPublic information about a registered app's {@link AppSearchDeepLink | searchDeepLinks}\n" + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L277" + }, + "signature": [ + "Pick & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx new file mode 100644 index 0000000000000..76d2d95f21e05 --- /dev/null +++ b/api_docs/core_application.mdx @@ -0,0 +1,27 @@ +--- +id: kibCoreApplicationPluginApi +slug: /kibana-dev-docs/core.applicationPluginApi +title: core.application +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.application plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import coreApplicationObj from './core_application.json'; + +## Client + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json new file mode 100644 index 0000000000000..76234a32faca4 --- /dev/null +++ b/api_docs/core_chrome.json @@ -0,0 +1,2537 @@ +{ + "id": "core.chrome", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.ChromeBadge", + "type": "Interface", + "label": "ChromeBadge", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeBadge.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.ChromeBadge.tooltip", + "type": "string", + "label": "tooltip", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.ChromeBadge.iconType", + "type": "CompoundType", + "label": "iconType", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L22" + }, + "signature": [ + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" + ] + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeBrand", + "type": "Interface", + "label": "ChromeBrand", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeBrand.logo", + "type": "string", + "label": "logo", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeBrand.smallLogo", + "type": "string", + "label": "smallLogo", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L28" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtension", + "type": "Interface", + "label": "ChromeHelpExtension", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeHelpExtension.appName", + "type": "string", + "label": "appName", + "description": [ + "\nProvide your plugin's name to create a header for separation" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L49" + } + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtension.links", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L53" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuLink", + "text": "ChromeHelpExtensionMenuLink" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtension.content", + "type": "Function", + "label": "content", + "description": [ + "\nCustom content to occur below the list of links" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L57" + }, + "signature": [ + "((element: HTMLDivElement) => () => void) | undefined" + ] + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionMenuCustomLink", + "type": "Interface", + "label": "ChromeHelpExtensionMenuCustomLink", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuCustomLink", + "text": "ChromeHelpExtensionMenuCustomLink" + }, + " extends Pick<(", + "DisambiguateSet", + "<", + "PropsForAnchor", + ", ", + "PropsForButton", + "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuCustomLink.linkType", + "type": "string", + "label": "linkType", + "description": [ + "\nExtend EuiButtonEmpty to provide extra functionality" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L86" + }, + "signature": [ + "\"custom\"" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuCustomLink.href", + "type": "string", + "label": "href", + "description": [ + "\nURL of the link" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L90" + } + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuCustomLink.content", + "type": "CompoundType", + "label": "content", + "description": [ + "\nContent of the button (in lieu of `children`)" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L94" + }, + "signature": [ + "React.ReactNode" + ] + } + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L82" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionMenuDiscussLink", + "type": "Interface", + "label": "ChromeHelpExtensionMenuDiscussLink", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuDiscussLink", + "text": "ChromeHelpExtensionMenuDiscussLink" + }, + " extends Pick<(", + "DisambiguateSet", + "<", + "PropsForAnchor", + ", ", + "PropsForButton", + "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuDiscussLink.linkType", + "type": "string", + "label": "linkType", + "description": [ + "\nCreates a generic give feedback link with comment icon" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L60" + }, + "signature": [ + "\"discuss\"" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuDiscussLink.href", + "type": "string", + "label": "href", + "description": [ + "\nURL to discuss page.\ni.e. `https://discuss.elastic.co/c/${appName}`" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L65" + } + } + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionMenuDocumentationLink", + "type": "Interface", + "label": "ChromeHelpExtensionMenuDocumentationLink", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuDocumentationLink", + "text": "ChromeHelpExtensionMenuDocumentationLink" + }, + " extends Pick<(", + "DisambiguateSet", + "<", + "PropsForAnchor", + ", ", + "PropsForButton", + "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuDocumentationLink.linkType", + "type": "string", + "label": "linkType", + "description": [ + "\nCreates a deep-link to app-specific documentation" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L73" + }, + "signature": [ + "\"documentation\"" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuDocumentationLink.href", + "type": "string", + "label": "href", + "description": [ + "\nURL to documentation page.\ni.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`," + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L78" + } + } + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionMenuGitHubLink", + "type": "Interface", + "label": "ChromeHelpExtensionMenuGitHubLink", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuGitHubLink", + "text": "ChromeHelpExtensionMenuGitHubLink" + }, + " extends Pick<(", + "DisambiguateSet", + "<", + "PropsForAnchor", + ", ", + "PropsForButton", + "> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (", + "DisambiguateSet" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuGitHubLink.linkType", + "type": "string", + "label": "linkType", + "description": [ + "\nCreates a link to a new github issue in the Kibana repo" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L44" + }, + "signature": [ + "\"github\"" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuGitHubLink.labels", + "type": "Array", + "label": "labels", + "description": [ + "\nInclude at least one app-specific label to be applied to the new github issue" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L48" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.ChromeHelpExtensionMenuGitHubLink.title", + "type": "string", + "label": "title", + "description": [ + "\nProvides initial text for the title of the issue" + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L52" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeNavControl", + "type": "Interface", + "label": "ChromeNavControl", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeNavControl.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L16" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavControl.mount", + "type": "Function", + "label": "mount", + "description": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L17" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ] + } + ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeNavControls", + "type": "Interface", + "label": "ChromeNavControls", + "description": [ + "\n{@link ChromeNavControls | APIs} for registering new controls to be displayed in the navigation bar.\n" + ], + "tags": [ + "example", + "public" + ], + "children": [ + { + "id": "def-public.ChromeNavControls.registerLeft", + "type": "Function", + "label": "registerLeft", + "signature": [ + "(navControl: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + }, + ") => void" + ], + "description": [ + "Register a nav control to be presented on the bottom-left side of the chrome header." + ], + "children": [ + { + "type": "Object", + "label": "navControl", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + } + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38" + } + }, + { + "id": "def-public.ChromeNavControls.registerRight", + "type": "Function", + "label": "registerRight", + "signature": [ + "(navControl: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + }, + ") => void" + ], + "description": [ + "Register a nav control to be presented on the top-right side of the chrome header." + ], + "children": [ + { + "type": "Object", + "label": "navControl", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + } + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40" + } + }, + { + "id": "def-public.ChromeNavControls.registerCenter", + "type": "Function", + "label": "registerCenter", + "signature": [ + "(navControl: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + }, + ") => void" + ], + "description": [ + "Register a nav control to be presented on the top-center side of the chrome header." + ], + "children": [ + { + "type": "Object", + "label": "navControl", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControl", + "text": "ChromeNavControl" + } + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42" + } + } + ], + "source": { + "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeNavLink", + "type": "Interface", + "label": "ChromeNavLink", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeNavLink.id", + "type": "string", + "label": "id", + "description": [ + "\nA unique identifier for looking up links." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.title", + "type": "string", + "label": "title", + "description": [ + "\nThe title of the application." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.category", + "type": "Object", + "label": "category", + "description": [ + "\nThe category the app lives in" + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L29" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.baseUrl", + "type": "string", + "label": "baseUrl", + "description": [ + "\nThe base route used to open the root of an application." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L34" + } + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.url", + "type": "string", + "label": "url", + "description": [ + "\nThe route used to open the {@link AppBase.defaultPath | default path } of an application.\nIf unset, `baseUrl` will be used instead." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L40" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.order", + "type": "number", + "label": "order", + "description": [ + "\nAn ordinal used to sort nav links relative to one another for display." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.tooltip", + "type": "string", + "label": "tooltip", + "description": [ + "\nA tooltip shown when hovering over an app link." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L50" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.euiIconType", + "type": "string", + "label": "euiIconType", + "description": [ + "\nA EUI iconType that will be used for the app's icon. This icon\ntakes precedence over the `icon` property." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L56" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.icon", + "type": "string", + "label": "icon", + "description": [ + "\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.href", + "type": "string", + "label": "href", + "description": [ + "\nSettled state between `url`, `baseUrl`, and `active`" + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L67" + } + }, + { + "tags": [ + "internalRemarks" + ], + "id": "def-public.ChromeNavLink.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [ + "\nDisables a link from being clickable.\n" + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L76" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ChromeNavLink.hidden", + "type": "CompoundType", + "label": "hidden", + "description": [ + "\nHides a link from the navigation." + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L81" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeNavLinks", + "type": "Interface", + "label": "ChromeNavLinks", + "description": [ + "\n{@link ChromeNavLinks | APIs} for manipulating nav links.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.ChromeNavLinks.getNavLinks$", + "type": "Function", + "label": "getNavLinks$", + "signature": [ + "() => ", + "Observable", + "[]>" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L32" + } + }, + { + "id": "def-public.ChromeNavLinks.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLink", + "text": "ChromeNavLink" + }, + " | undefined" + ], + "description": [ + "\nGet the state of a navlink at this point in time." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38" + } + }, + { + "id": "def-public.ChromeNavLinks.getAll", + "type": "Function", + "label": "getAll", + "signature": [ + "() => Readonly<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLink", + "text": "ChromeNavLink" + }, + ">[]" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L43" + } + }, + { + "id": "def-public.ChromeNavLinks.has", + "type": "Function", + "label": "has", + "signature": [ + "(id: string) => boolean" + ], + "description": [ + "\nCheck whether or not a navlink exists." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49" + } + }, + { + "id": "def-public.ChromeNavLinks.showOnly", + "type": "Function", + "label": "showOnly", + "signature": [ + "(id: string) => void" + ], + "description": [ + "\nRemove all navlinks except the one matching the given id.\n" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59" + } + } + ], + "tags": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59" + } + }, + { + "id": "def-public.ChromeNavLinks.update", + "type": "Function", + "label": "update", + "signature": [ + "(id: string, values: Partial>) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLink", + "text": "ChromeNavLink" + }, + " | undefined" + ], + "description": [ + "\nUpdate the navlink for the given id with the updated attributes.\nReturns the updated navlink or `undefined` if it does not exist.\n" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71" + } + }, + { + "type": "Object", + "label": "values", + "isRequired": true, + "signature": [ + "Partial>" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71" + } + } + ], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71" + } + }, + { + "id": "def-public.ChromeNavLinks.enableForcedAppSwitcherNavigation", + "type": "Function", + "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": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L85" + } + }, + { + "id": "def-public.ChromeNavLinks.getForceAppSwitcherNavigation$", + "type": "Function", + "label": "getForceAppSwitcherNavigation$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L90" + } + } + ], + "source": { + "path": "src/core/public/chrome/nav_links/nav_links_service.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeDocTitle", + "type": "Interface", + "label": "ChromeDocTitle", + "description": [ + "\nAPIs for accessing and updating the document title.\n" + ], + "tags": [ + "example", + "example", + "public" + ], + "children": [ + { + "id": "def-public.ChromeDocTitle.change", + "type": "Function", + "label": "change", + "signature": [ + "(newTitle: string | string[]) => void" + ], + "description": [ + "\nChanges the current document title.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "newTitle", + "isRequired": true, + "signature": [ + "string | string[]" + ], + "description": [ + "The new title to set, either a string or string array" + ], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45" + } + }, + { + "id": "def-public.ChromeDocTitle.reset", + "type": "Function", + "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": [], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L50" + } + } + ], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeRecentlyAccessed", + "type": "Interface", + "label": "ChromeRecentlyAccessed", + "description": [ + "\n{@link ChromeRecentlyAccessed | APIs} for recently accessed history." + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.ChromeRecentlyAccessed.add", + "type": "Function", + "label": "add", + "signature": [ + "(link: string, label: string, id: string) => void" + ], + "description": [ + "\nAdds a new item to the recently accessed history.\n" + ], + "children": [ + { + "type": "string", + "label": "link", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "a relative URL to the resource (not including the {@link HttpStart.basePath | `http.basePath`})" + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71" + } + }, + { + "type": "string", + "label": "label", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "the label to display in the UI" + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "a unique string used to de-duplicate the recently accessed list." + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71" + } + }, + { + "id": "def-public.ChromeRecentlyAccessed.get", + "type": "Function", + "label": "get", + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeRecentlyAccessedHistoryItem", + "text": "ChromeRecentlyAccessedHistoryItem" + }, + "[]" + ], + "description": [ + "\nGets an Array of the current recently accessed history.\n" + ], + "children": [], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L81" + } + }, + { + "id": "def-public.ChromeRecentlyAccessed.get$", + "type": "Function", + "label": "get$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeRecentlyAccessedHistoryItem", + "text": "ChromeRecentlyAccessedHistoryItem" + }, + "[]>" + ], + "description": [ + "\nGets an Observable of the array of recently accessed history.\n" + ], + "children": [], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L91" + } + } + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeRecentlyAccessedHistoryItem", + "type": "Interface", + "label": "ChromeRecentlyAccessedHistoryItem", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeRecentlyAccessedHistoryItem.link", + "type": "string", + "label": "link", + "description": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.ChromeRecentlyAccessedHistoryItem.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.ChromeRecentlyAccessedHistoryItem.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L19" + } + } + ], + "source": { + "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeUserBanner", + "type": "Interface", + "label": "ChromeUserBanner", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeUserBanner.content", + "type": "Function", + "label": "content", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L41" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ] + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeStart", + "type": "Interface", + "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": [ + "remarks", + "example", + "example", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeStart.navLinks", + "type": "Object", + "label": "navLinks", + "description": [ + "{@inheritdoc ChromeNavLinks}" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L88" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLinks", + "text": "ChromeNavLinks" + } + ] + }, + { + "tags": [], + "id": "def-public.ChromeStart.navControls", + "type": "Object", + "label": "navControls", + "description": [ + "{@inheritdoc ChromeNavControls}" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L90" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavControls", + "text": "ChromeNavControls" + } + ] + }, + { + "tags": [], + "id": "def-public.ChromeStart.recentlyAccessed", + "type": "Object", + "label": "recentlyAccessed", + "description": [ + "{@inheritdoc ChromeRecentlyAccessed}" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L92" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeRecentlyAccessed", + "text": "ChromeRecentlyAccessed" + } + ] + }, + { + "tags": [], + "id": "def-public.ChromeStart.docTitle", + "type": "Object", + "label": "docTitle", + "description": [ + "{@inheritdoc ChromeDocTitle}" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L94" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeDocTitle", + "text": "ChromeDocTitle" + } + ] + }, + { + "id": "def-public.ChromeStart.setAppTitle", + "type": "Function", + "label": "setAppTitle", + "signature": [ + "(appTitle: string) => void" + ], + "description": [ + "\nSets the current app's title\n" + ], + "children": [ + { + "type": "string", + "label": "appTitle", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103" + } + } + ], + "tags": [ + "internalRemarks" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103" + } + }, + { + "id": "def-public.ChromeStart.getBrand$", + "type": "Function", + "label": "getBrand$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBrand", + "text": "ChromeBrand" + }, + ">" + ], + "description": [ + "\nGet an observable of the current brand information." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L108" + } + }, + { + "id": "def-public.ChromeStart.setBrand", + "type": "Function", + "label": "setBrand", + "signature": [ + "(brand: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBrand", + "text": "ChromeBrand" + }, + ") => void" + ], + "description": [ + "\nSet the brand configuration.\n" + ], + "children": [ + { + "type": "Object", + "label": "brand", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBrand", + "text": "ChromeBrand" + } + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128" + } + } + ], + "tags": [ + "remarks", + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128" + } + }, + { + "id": "def-public.ChromeStart.getIsVisible$", + "type": "Function", + "label": "getIsVisible$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L133" + } + }, + { + "id": "def-public.ChromeStart.setIsVisible", + "type": "Function", + "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." + ], + "children": [ + { + "type": "boolean", + "label": "isVisible", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140" + } + }, + { + "id": "def-public.ChromeStart.getApplicationClasses$", + "type": "Function", + "label": "getApplicationClasses$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L145" + } + }, + { + "id": "def-public.ChromeStart.addApplicationClass", + "type": "Function", + "label": "addApplicationClass", + "signature": [ + "(className: string) => void" + ], + "description": [ + "\nAdd a className that should be set on the application container." + ], + "children": [ + { + "type": "string", + "label": "className", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150" + } + }, + { + "id": "def-public.ChromeStart.removeApplicationClass", + "type": "Function", + "label": "removeApplicationClass", + "signature": [ + "(className: string) => void" + ], + "description": [ + "\nRemove a className added with `addApplicationClass()`. If className is unknown it is ignored." + ], + "children": [ + { + "type": "string", + "label": "className", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155" + } + }, + { + "id": "def-public.ChromeStart.getBadge$", + "type": "Function", + "label": "getBadge$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBadge", + "text": "ChromeBadge" + }, + " | undefined>" + ], + "description": [ + "\nGet an observable of the current badge" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L160" + } + }, + { + "id": "def-public.ChromeStart.setBadge", + "type": "Function", + "label": "setBadge", + "signature": [ + "(badge?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBadge", + "text": "ChromeBadge" + }, + " | undefined) => void" + ], + "description": [ + "\nOverride the current badge" + ], + "children": [ + { + "type": "Object", + "label": "badge", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBadge", + "text": "ChromeBadge" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165" + } + }, + { + "id": "def-public.ChromeStart.getBreadcrumbs$", + "type": "Function", + "label": "getBreadcrumbs$", + "signature": [ + "() => ", + "Observable", + "<", + "EuiBreadcrumb", + "[]>" + ], + "description": [ + "\nGet an observable of the current list of breadcrumbs" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L170" + } + }, + { + "id": "def-public.ChromeStart.setBreadcrumbs", + "type": "Function", + "label": "setBreadcrumbs", + "signature": [ + "(newBreadcrumbs: ", + "EuiBreadcrumb", + "[]) => void" + ], + "description": [ + "\nOverride the current set of breadcrumbs" + ], + "children": [ + { + "type": "Array", + "label": "newBreadcrumbs", + "isRequired": true, + "signature": [ + "EuiBreadcrumb", + "[]" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175" + } + }, + { + "id": "def-public.ChromeStart.getBreadcrumbsAppendExtension$", + "type": "Function", + "label": "getBreadcrumbsAppendExtension$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBreadcrumbsAppendExtension", + "text": "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L180" + } + }, + { + "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension", + "type": "Function", + "label": "setBreadcrumbsAppendExtension", + "signature": [ + "(breadcrumbsAppendExtension?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBreadcrumbsAppendExtension", + "text": "ChromeBreadcrumbsAppendExtension" + }, + " | undefined) => void" + ], + "description": [ + "\nMount an element next to the last breadcrumb" + ], + "children": [ + { + "type": "Object", + "label": "breadcrumbsAppendExtension", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeBreadcrumbsAppendExtension", + "text": "ChromeBreadcrumbsAppendExtension" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L186" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L185" + } + }, + { + "id": "def-public.ChromeStart.getCustomNavLink$", + "type": "Function", + "label": "getCustomNavLink$", + "signature": [ + "() => ", + "Observable", + " | undefined>" + ], + "description": [ + "\nGet an observable of the current custom nav link" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L192" + } + }, + { + "id": "def-public.ChromeStart.setCustomNavLink", + "type": "Function", + "label": "setCustomNavLink", + "signature": [ + "(newCustomNavLink?: Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLink", + "text": "ChromeNavLink" + }, + "> | undefined) => void" + ], + "description": [ + "\nOverride the current set of custom nav link" + ], + "children": [ + { + "type": "Object", + "label": "newCustomNavLink", + "isRequired": false, + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeNavLink", + "text": "ChromeNavLink" + }, + "> | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197" + } + }, + { + "id": "def-public.ChromeStart.getHelpExtension$", + "type": "Function", + "label": "getHelpExtension$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtension", + "text": "ChromeHelpExtension" + }, + " | undefined>" + ], + "description": [ + "\nGet an observable of the current custom help conttent" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L202" + } + }, + { + "id": "def-public.ChromeStart.setHelpExtension", + "type": "Function", + "label": "setHelpExtension", + "signature": [ + "(helpExtension?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtension", + "text": "ChromeHelpExtension" + }, + " | undefined) => void" + ], + "description": [ + "\nOverride the current set of custom help content" + ], + "children": [ + { + "type": "Object", + "label": "helpExtension", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtension", + "text": "ChromeHelpExtension" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207" + } + }, + { + "id": "def-public.ChromeStart.setHelpSupportUrl", + "type": "Function", + "label": "setHelpSupportUrl", + "signature": [ + "(url: string) => void" + ], + "description": [ + "\nOverride the default support URL shown in the help menu" + ], + "children": [ + { + "type": "string", + "label": "url", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "The updated support URL" + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213" + } + }, + { + "id": "def-public.ChromeStart.getIsNavDrawerLocked$", + "type": "Function", + "label": "getIsNavDrawerLocked$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L218" + } + }, + { + "id": "def-public.ChromeStart.setHeaderBanner", + "type": "Function", + "label": "setHeaderBanner", + "signature": [ + "(headerBanner?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeUserBanner", + "text": "ChromeUserBanner" + }, + " | undefined) => void" + ], + "description": [ + "\nSet the banner that will appear on top of the chrome header.\n" + ], + "children": [ + { + "type": "Object", + "label": "headerBanner", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeUserBanner", + "text": "ChromeUserBanner" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225" + } + } + ], + "tags": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225" + } + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L86" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.ChromeBreadcrumb", + "type": "Type", + "label": "ChromeBreadcrumb", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L32" + }, + "signature": [ + "CommonProps", + " & { text: ", + "ReactNode", + "; href?: string | undefined; onClick?: ((event: ", + "MouseEvent", + ") => void) | undefined; truncate?: boolean | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionMenuLink", + "type": "Type", + "label": "ChromeHelpExtensionMenuLink", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L98" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuGitHubLink", + "text": "ChromeHelpExtensionMenuGitHubLink" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuDiscussLink", + "text": "ChromeHelpExtensionMenuDiscussLink" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuDocumentationLink", + "text": "ChromeHelpExtensionMenuDocumentationLink" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreChromePluginApi", + "section": "def-public.ChromeHelpExtensionMenuCustomLink", + "text": "ChromeHelpExtensionMenuCustomLink" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.ChromeHelpExtensionLinkBase", + "type": "Type", + "label": "ChromeHelpExtensionLinkBase", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L34" + }, + "signature": [ + "{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ChromeNavLinkUpdateableFields", + "type": "Type", + "label": "ChromeNavLinkUpdateableFields", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/nav_links/nav_link.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L85" + }, + "signature": [ + "{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.NavType", + "type": "Type", + "label": "NavType", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/chrome/ui/header/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/types.ts#L10" + }, + "signature": [ + "\"legacy\" | \"modern\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx new file mode 100644 index 0000000000000..a9e100b79a91e --- /dev/null +++ b/api_docs/core_chrome.mdx @@ -0,0 +1,21 @@ +--- +id: kibCoreChromePluginApi +slug: /kibana-dev-docs/core.chromePluginApi +title: core.chrome +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.chrome plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import coreChromeObj from './core_chrome.json'; + +## Client + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/core_http.json b/api_docs/core_http.json new file mode 100644 index 0000000000000..13edda7ee6554 --- /dev/null +++ b/api_docs/core_http.json @@ -0,0 +1,7035 @@ +{ + "id": "core.http", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.HttpHeadersInit", + "type": "Interface", + "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" + ], + "children": [ + { + "id": "def-public.HttpHeadersInit.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L145" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L144" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpRequestInit", + "type": "Interface", + "label": "HttpRequestInit", + "description": [ + "\nFetch API options available to {@link HttpHandler}s.\n" + ], + "tags": [ + "internalRemarks", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpRequestInit.body", + "type": "CompoundType", + "label": "body", + "description": [ + "\nA BodyInit object or null to set request's body." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L158" + }, + "signature": [ + "string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.cache", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L164" + }, + "signature": [ + "\"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.credentials", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L170" + }, + "signature": [ + "\"include\" | \"omit\" | \"same-origin\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.headers", + "type": "Object", + "label": "headers", + "description": [ + "{@link HttpHeadersInit}" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L173" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.integrity", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L179" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.keepalive", + "type": "CompoundType", + "label": "keepalive", + "description": [ + "Whether or not request can outlive the global in which it was created." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L182" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.method", + "type": "string", + "label": "method", + "description": [ + "HTTP method, which is \"GET\" by default." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L185" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.mode", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 191, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L191" + }, + "signature": [ + "\"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.redirect", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L197" + }, + "signature": [ + "\"error\" | \"manual\" | \"follow\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.referrer", + "type": "string", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L204" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.referrerPolicy", + "type": "CompoundType", + "label": "referrerPolicy", + "description": [ + "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L210" + }, + "signature": [ + "\"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.signal", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L216" + }, + "signature": [ + "AbortSignal | null | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpRequestInit.window", + "type": "Uncategorized", + "label": "window", + "description": [ + "\nCan only be null. Used to disassociate request from any Window." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L221" + }, + "signature": [ + "null | undefined" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L154" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpFetchOptions", + "type": "Interface", + "label": "HttpFetchOptions", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptions", + "text": "HttpFetchOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpRequestInit", + "text": "HttpRequestInit" + } + ], + "description": [ + "\nAll options that may be used with a {@link HttpHandler}." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpFetchOptions.query", + "type": "Object", + "label": "query", + "description": [ + "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 249, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L249" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpFetchOptions.prependBasePath", + "type": "CompoundType", + "label": "prependBasePath", + "description": [ + "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L254" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpFetchOptions.headers", + "type": "Object", + "label": "headers", + "description": [ + "\nHeaders to send with the request. See {@link HttpHeadersInit}." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L259" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpFetchOptions.asSystemRequest", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L266" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpFetchOptions.asResponse", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 272, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L272" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L245" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpFetchOptionsWithPath", + "type": "Interface", + "label": "HttpFetchOptionsWithPath", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptions", + "text": "HttpFetchOptions" + } + ], + "description": [ + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpFetchOptionsWithPath.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 283, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L283" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 279, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L279" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpFetchQuery", + "type": "Interface", + "label": "HttpFetchQuery", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.HttpFetchQuery.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "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;" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L238" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L225" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpInterceptorResponseError", + "type": "Interface", + "label": "HttpInterceptorResponseError", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpInterceptorResponseError.request", + "type": "Object", + "label": "request", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 347, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L347" + }, + "signature": [ + "Readonly" + ] + }, + { + "tags": [], + "id": "def-public.HttpInterceptorResponseError.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L348" + }, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpFetchError", + "text": "IHttpFetchError" + } + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 346, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L346" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpInterceptorRequestError", + "type": "Interface", + "label": "HttpInterceptorRequestError", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpInterceptorRequestError.fetchOptions", + "type": "Object", + "label": "fetchOptions", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 352, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L352" + }, + "signature": [ + "Readonly<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.HttpInterceptorRequestError.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 353, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L353" + }, + "signature": [ + "Error" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 351, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L351" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpInterceptor", + "type": "Interface", + "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" + ], + "children": [ + { + "id": "def-public.HttpInterceptor.request", + "type": "Function", + "label": "request", + "signature": [ + "((fetchOptions: Readonly<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">, controller: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + "> | Promise>) | undefined" + ], + "description": [ + "\nDefine an interceptor to be executed before a request is sent." + ], + "children": [ + { + "type": "Object", + "label": "fetchOptions", + "isRequired": true, + "signature": [ + "Readonly<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">" + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L369" + } + }, + { + "type": "Object", + "label": "controller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 370, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L370" + } + } + ], + "tags": [ + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 368, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L368" + } + }, + { + "id": "def-public.HttpInterceptor.requestError", + "type": "Function", + "label": "requestError", + "signature": [ + "((httpErrorRequest: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + }, + ", controller: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + "> | Promise>) | undefined" + ], + "description": [ + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." + ], + "children": [ + { + "type": "Object", + "label": "httpErrorRequest", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 379, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L379" + } + }, + { + "type": "Object", + "label": "controller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 380, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L380" + } + } + ], + "tags": [ + "link", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 378, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L378" + } + }, + { + "id": "def-public.HttpInterceptor.response", + "type": "Function", + "label": "response", + "signature": [ + "((httpResponse: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpResponse", + "text": "HttpResponse" + }, + ", controller: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "description": [ + "\nDefine an interceptor to be executed after a response is received." + ], + "children": [ + { + "type": "Object", + "label": "httpResponse", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 389, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L389" + } + }, + { + "type": "Object", + "label": "controller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 390, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L390" + } + } + ], + "tags": [ + "link", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 388, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L388" + } + }, + { + "id": "def-public.HttpInterceptor.responseError", + "type": "Function", + "label": "responseError", + "signature": [ + "((httpErrorResponse: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + ", controller: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "description": [ + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." + ], + "children": [ + { + "type": "Object", + "label": "httpErrorResponse", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 399, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L399" + } + }, + { + "type": "Object", + "label": "controller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 400, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L400" + } + } + ], + "tags": [ + "link", + "link" + ], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 398, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L398" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 362, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L362" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpResponse", + "type": "Interface", + "label": "HttpResponse", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpResponse.fetchOptions", + "type": "Object", + "label": "fetchOptions", + "description": [ + "The original {@link HttpFetchOptionsWithPath} used to send this request." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 309, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L309" + }, + "signature": [ + "Readonly<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.HttpResponse.request", + "type": "Object", + "label": "request", + "description": [ + "Raw request sent to Kibana server." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L311" + }, + "signature": [ + "Readonly" + ] + }, + { + "tags": [], + "id": "def-public.HttpResponse.response", + "type": "Object", + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L313" + }, + "signature": [ + "Readonly | undefined" + ] + }, + { + "tags": [], + "id": "def-public.HttpResponse.body", + "type": "Uncategorized", + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 315, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L315" + }, + "signature": [ + "TResponseBody | undefined" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L307" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpHandler", + "type": "Interface", + "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": [ + "link", + "public" + ], + "children": [ + { + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 296, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L296" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L299" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L302" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 303, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L303" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 295, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L295" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IBasePath", + "type": "Interface", + "label": "IBasePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.IBasePath.get", + "type": "Function", + "label": "get", + "description": [ + "\nGets the `basePath` string." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L78" + }, + "signature": [ + "() => string" + ] + }, + { + "tags": [], + "id": "def-public.IBasePath.prepend", + "type": "Function", + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L83" + }, + "signature": [ + "(url: string) => string" + ] + }, + { + "tags": [], + "id": "def-public.IBasePath.remove", + "type": "Function", + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L88" + }, + "signature": [ + "(url: string) => string" + ] + }, + { + "tags": [], + "id": "def-public.IBasePath.serverBasePath", + "type": "string", + "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" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L95" + } + }, + { + "tags": [ + "remarks" + ], + "id": "def-public.IBasePath.publicBaseUrl", + "type": "string", + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L104" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IAnonymousPaths", + "type": "Interface", + "label": "IAnonymousPaths", + "description": [ + "\nAPIs for denoting paths as not requiring authentication" + ], + "tags": [], + "children": [ + { + "id": "def-public.IAnonymousPaths.isAnonymous", + "type": "Function", + "label": "isAnonymous", + "signature": [ + "(path: string) => boolean" + ], + "description": [ + "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." + ], + "children": [ + { + "type": "string", + "label": "path", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L131" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L131" + } + }, + { + "id": "def-public.IAnonymousPaths.register", + "type": "Function", + "label": "register", + "signature": [ + "(path: string) => void" + ], + "description": [ + "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." + ], + "children": [ + { + "type": "string", + "label": "path", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L136" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L136" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L127" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IExternalUrl", + "type": "Interface", + "label": "IExternalUrl", + "description": [ + "\nAPIs for working with external URLs.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-public.IExternalUrl.validateUrl", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "relativeOrAbsoluteUrl", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L121" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L121" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L111" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IHttpInterceptController", + "type": "Interface", + "label": "IHttpInterceptController", + "description": [ + "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.IHttpInterceptController.halted", + "type": "boolean", + "label": "halted", + "description": [ + "Whether or not this chain has been halted." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 410, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L410" + } + }, + { + "id": "def-public.IHttpInterceptController.halt", + "type": "Function", + "label": "halt", + "signature": [ + "() => void" + ], + "description": [ + "Halt the request Promise chain and do not process further interceptors or response handlers." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 412, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L412" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L408" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IHttpFetchError", + "type": "Interface", + "label": "IHttpFetchError", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpFetchError", + "text": "IHttpFetchError" + }, + " extends Error" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.IHttpFetchError.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L331" + } + }, + { + "tags": [], + "id": "def-public.IHttpFetchError.request", + "type": "Object", + "label": "request", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 332, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L332" + }, + "signature": [ + "Request" + ] + }, + { + "tags": [], + "id": "def-public.IHttpFetchError.response", + "type": "Object", + "label": "response", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 333, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L333" + }, + "signature": [ + "Response | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.IHttpFetchError.req", + "type": "Object", + "label": "req", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 337, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L337" + }, + "signature": [ + "Request" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.IHttpFetchError.res", + "type": "Object", + "label": "res", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 341, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L341" + }, + "signature": [ + "Response | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IHttpFetchError.body", + "type": "Any", + "label": "body", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 342, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L342" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 330, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L330" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IHttpResponseInterceptorOverrides", + "type": "Interface", + "label": "IHttpResponseInterceptorOverrides", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + "" + ], + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.IHttpResponseInterceptorOverrides.response", + "type": "Object", + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 324, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L324" + }, + "signature": [ + "Readonly | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IHttpResponseInterceptorOverrides.body", + "type": "Uncategorized", + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 326, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L326" + }, + "signature": [ + "TResponseBody | undefined" + ] + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 322, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L322" + }, + "initialIsOpen": false + }, + { + "id": "def-public.HttpSetup", + "type": "Interface", + "label": "HttpSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HttpSetup.basePath", + "type": "Object", + "label": "basePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L18" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IBasePath", + "text": "IBasePath" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.anonymousPaths", + "type": "Object", + "label": "anonymousPaths", + "description": [ + "\nAPIs for denoting certain paths for not requiring authentication" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L23" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IAnonymousPaths", + "text": "IAnonymousPaths" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.externalUrl", + "type": "Object", + "label": "externalUrl", + "description": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L25" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.IExternalUrl", + "text": "IExternalUrl" + } + ] + }, + { + "id": "def-public.HttpSetup.intercept", + "type": "Function", + "label": "intercept", + "signature": [ + "(interceptor: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptor", + "text": "HttpInterceptor" + }, + ") => () => void" + ], + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], + "children": [ + { + "type": "Object", + "label": "interceptor", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpInterceptor", + "text": "HttpInterceptor" + } + ], + "description": [ + "a {@link HttpInterceptor}" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L32" + } + } + ], + "tags": [], + "returnComment": [ + "a function for removing the attached interceptor." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L32" + } + }, + { + "tags": [], + "id": "def-public.HttpSetup.fetch", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L35" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.delete", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L37" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.get", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L39" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.head", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L41" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.options", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L43" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.patch", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L45" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.post", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L47" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "tags": [], + "id": "def-public.HttpSetup.put", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L49" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpHandler", + "text": "HttpHandler" + } + ] + }, + { + "id": "def-public.HttpSetup.addLoadingCountSource", + "type": "Function", + "label": "addLoadingCountSource", + "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." + ], + "children": [ + { + "type": "Object", + "label": "countSource$", + "isRequired": true, + "signature": [ + "Observable", + "" + ], + "description": [ + "an Observable to subscribe to for loading count updates." + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L56" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L56" + } + }, + { + "id": "def-public.HttpSetup.getLoadingCount$", + "type": "Function", + "label": "getLoadingCount$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L61" + } + } + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L13" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.HttpStart", + "type": "Type", + "label": "HttpStart", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link HttpSetup}" + ], + "source": { + "path": "src/core/public/http/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L68" + }, + "signature": [ + "HttpSetup" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.BasePath", + "type": "Class", + "tags": [ + "public" + ], + "label": "BasePath", + "description": [ + "\nAccess or manipulate the Kibana base path\n" + ], + "children": [ + { + "tags": [], + "id": "def-server.BasePath.serverBasePath", + "type": "string", + "label": "serverBasePath", + "description": [ + "\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L26" + } + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.BasePath.publicBaseUrl", + "type": "string", + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n" + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L34" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-server.BasePath.get", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "description": [], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L45" + } + } + ], + "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" + ], + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "label": "get", + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L45" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.BasePath.set", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "description": [], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55" + } + }, + { + "type": "string", + "label": "requestSpecificBasePath", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55" + }, + "tags": [ + "privateRemarks" + ], + "returnComment": [] + }, + { + "id": "def-server.BasePath.prepend", + "type": "Function", + "children": [ + { + "type": "string", + "label": "path", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L69" + } + } + ], + "signature": [ + "(path: string) => string" + ], + "description": [ + "\nPrepends `path` with the basePath." + ], + "label": "prepend", + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L69" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.BasePath.remove", + "type": "Function", + "children": [ + { + "type": "string", + "label": "path", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L81" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L81" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-server.KibanaRequest", + "type": "Class", + "tags": [ + "public" + ], + "label": "KibanaRequest", + "description": [ + "\nKibana specific abstraction for an incoming request." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "children": [ + { + "tags": [ + "remarks" + ], + "id": "def-server.KibanaRequest.id", + "type": "string", + "label": "id", + "description": [ + "\nA identifier to identify this request.\n" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L145" + } + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.KibanaRequest.uuid", + "type": "string", + "label": "uuid", + "description": [ + "\nA UUID to identify this request.\n" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L153" + } + }, + { + "tags": [], + "id": "def-server.KibanaRequest.url", + "type": "Object", + "label": "url", + "description": [ + "a WHATWG URL standard object." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L155" + }, + "signature": [ + "URL" + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequest.route", + "type": "Object", + "label": "route", + "description": [ + "matched route details" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L157" + }, + "signature": [ + "Readonly<{ path: string; method: ", + "RecursiveReadonly", + "; options: ", + "RecursiveReadonly", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequestRouteOptions", + "text": "KibanaRequestRouteOptions" + }, + ">; }>" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.KibanaRequest.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "\nReadonly copy of incoming request headers." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L163" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequest.isSystemRequest", + "type": "boolean", + "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." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L168" + } + }, + { + "tags": [], + "id": "def-server.KibanaRequest.socket", + "type": "Object", + "label": "socket", + "description": [ + "{@link IKibanaSocket}" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L171" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaSocket", + "text": "IKibanaSocket" + } + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequest.events", + "type": "Object", + "label": "events", + "description": [ + "Request events {@link KibanaRequestEvents}" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L173" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequestEvents", + "text": "KibanaRequestEvents" + } + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequest.auth", + "type": "Object", + "label": "auth", + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L174" + }, + "signature": [ + "{ isAuthenticated: boolean; }" + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequest.rewrittenUrl", + "type": "Object", + "label": "rewrittenUrl", + "description": [ + "\nURL rewritten in onPreRouting request interceptor." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L182" + }, + "signature": [ + "URL", + " | undefined" + ] + }, + { + "id": "def-server.KibanaRequest.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + "Request" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L188" + } + }, + { + "type": "Uncategorized", + "label": "params", + "isRequired": true, + "signature": [ + "Params" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L189" + } + }, + { + "type": "Uncategorized", + "label": "query", + "isRequired": true, + "signature": [ + "Query" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L190" + } + }, + { + "type": "Uncategorized", + "label": "body", + "isRequired": true, + "signature": [ + "Body" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 191, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L191" + } + }, + { + "type": "boolean", + "label": "withoutSecretHeaders", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L194" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L187" + } + } + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L90" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidationError", + "type": "Class", + "tags": [ + "public" + ], + "label": "RouteValidationError", + "description": [ + "\nError to return when the validation is not successful." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + " extends ", + "SchemaTypeError" + ], + "children": [ + { + "id": "def-server.RouteValidationError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + }, + { + "type": "Array", + "label": "path", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + } + ], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L15" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-server.AuthResultParams", + "type": "Interface", + "label": "AuthResultParams", + "description": [ + "\nResult of successful authentication." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AuthResultParams.state", + "type": "Object", + "label": "state", + "description": [ + "\nData to associate with an incoming request. Any downstream plugin may get access to the data." + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L92" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AuthResultParams.requestHeaders", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L97" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AuthResultParams.responseHeaders", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L102" + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AuthToolkit", + "type": "Interface", + "label": "AuthToolkit", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AuthToolkit.authenticated", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L123" + }, + "signature": [ + "(data?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ] + }, + { + "tags": [], + "id": "def-server.AuthToolkit.notHandled", + "type": "Function", + "label": "notHandled", + "description": [ + "\nUser has no credentials.\nAllows user to access a resource when authRequired: 'optional'\nRejects a request when authRequired: true" + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L129" + }, + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ] + }, + { + "tags": [], + "id": "def-server.AuthToolkit.redirected", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L134" + }, + "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)) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L121" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AuthRedirected", + "type": "Interface", + "label": "AuthRedirected", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirectedParams", + "text": "AuthRedirectedParams" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AuthRedirected.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L40" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".redirected" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AuthRedirectedParams", + "type": "Interface", + "label": "AuthRedirectedParams", + "description": [ + "\nResult of auth redirection." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AuthRedirectedParams.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "\nHeaders to attach for auth redirect.\nMust include \"location\" header" + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L114" + }, + "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": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L109" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Authenticated", + "type": "Interface", + "label": "Authenticated", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.Authenticated.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L30" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".authenticated" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AuthNotHandled", + "type": "Interface", + "label": "AuthNotHandled", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.AuthNotHandled.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L35" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".notHandled" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CustomHttpResponseOptions", + "type": "Interface", + "label": "CustomHttpResponseOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "" + ], + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.CustomHttpResponseOptions.body", + "type": "Uncategorized", + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L79" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-server.CustomHttpResponseOptions.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L81" + }, + "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.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L82" + } + } + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpAuth", + "type": "Interface", + "label": "HttpAuth", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpAuth.get", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L51" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.GetAuthState", + "text": "GetAuthState" + } + ] + }, + { + "tags": [], + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L56" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IsAuthenticated", + "text": "IsAuthenticated" + } + ] + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpResponseOptions", + "type": "Interface", + "label": "HttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpResponseOptions.body", + "type": "CompoundType", + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L62" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponsePayload", + "text": "HttpResponsePayload" + } + ] + }, + { + "tags": [], + "id": "def-server.HttpResponseOptions.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L64" + }, + "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": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpServerInfo", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpServerInfo.name", + "type": "string", + "label": "name", + "description": [ + "The name of the Kibana server" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 336, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L336" + } + }, + { + "tags": [], + "id": "def-server.HttpServerInfo.hostname", + "type": "string", + "label": "hostname", + "description": [ + "The hostname of the server" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 338, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L338" + } + }, + { + "tags": [], + "id": "def-server.HttpServerInfo.port", + "type": "number", + "label": "port", + "description": [ + "The port the server is listening on" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 340, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L340" + } + }, + { + "tags": [], + "id": "def-server.HttpServerInfo.protocol", + "type": "CompoundType", + "label": "protocol", + "description": [ + "The protocol used by the server" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 342, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L342" + }, + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ] + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 334, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L334" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpServiceSetup", + "type": "Interface", + "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": [ + "example", + "kbn", + "kbn", + "public" + ], + "children": [ + { + "tags": [ + "link" + ], + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", + "type": "Function", + "label": "createCookieSessionStorageFactory", + "description": [ + "\nCreates cookie based session storage factory {@link SessionStorageFactory}" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L136" + }, + "signature": [ + "(cookieOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + ">" + ] + }, + { + "tags": [ + "remarks", + "link" + ], + "id": "def-server.HttpServiceSetup.registerOnPreRouting", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L150" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "remarks", + "link" + ], + "id": "def-server.HttpServiceSetup.registerOnPreAuth", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L162" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "remarks", + "link" + ], + "id": "def-server.HttpServiceSetup.registerAuth", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L174" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "remarks", + "link" + ], + "id": "def-server.HttpServiceSetup.registerOnPostAuth", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L186" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + }, + ") => void" + ] + }, + { + "tags": [ + "remarks", + "link" + ], + "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "type": "Function", + "label": "registerOnPreResponse", + "description": [ + "\nTo define custom logic to perform for the server response.\n" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L198" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L204" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.BasePath", + "text": "BasePath" + }, + ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L212" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ] + }, + { + "tags": [], + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L217" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICspConfig", + "text": "ICspConfig" + } + ] + }, + { + "tags": [ + "remarks", + "example", + "public" + ], + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L234" + }, + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ] + }, + { + "tags": [ + "example", + "public" + ], + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L266" + }, + "signature": [ + "(contextName: ContextName, provider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandlerContextContainer", + "text": "RequestHandlerContextContainer" + } + ] + }, + { + "tags": [], + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L277" + }, + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ] + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L131" + }, + "initialIsOpen": false + }, + { + "id": "def-server.HttpServiceStart", + "type": "Interface", + "label": "HttpServiceStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 308, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L308" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.BasePath", + "text": "BasePath" + }, + ", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">" + ] + }, + { + "tags": [], + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 314, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L314" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ] + }, + { + "tags": [], + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L319" + }, + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ] + } + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 303, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L303" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ErrorHttpResponseOptions", + "type": "Interface", + "label": "ErrorHttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.ErrorHttpResponseOptions.body", + "type": "CompoundType", + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L101" + }, + "signature": [ + "string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ErrorHttpResponseOptions.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L103" + }, + "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": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L99" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IKibanaSocket", + "type": "Interface", + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "label": "getPeerCertificate", + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "PeerCertificate", + " | null; }" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "detailed", + "isRequired": true, + "signature": [ + "true" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L18" + } + }, + { + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "label": "getPeerCertificate", + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "PeerCertificate", + " | null; }" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "detailed", + "isRequired": true, + "signature": [ + "false" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L19" + } + }, + { + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "label": "getPeerCertificate", + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "DetailedPeerCertificate", + " | ", + "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." + ], + "children": [ + { + "type": "CompoundType", + "label": "detailed", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L29" + } + } + ], + "tags": [], + "returnComment": [ + "An object representing the peer's certificate." + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L29" + } + }, + { + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "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": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L36" + } + }, + { + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "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." + ], + "children": [ + { + "id": "def-server.IKibanaSocket.renegotiate.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IKibanaSocket.renegotiate.options.rejectUnauthorized", + "type": "CompoundType", + "label": "rejectUnauthorized", + "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IKibanaSocket.renegotiate.options.requestCert", + "type": "CompoundType", + "label": "requestCert", + "description": [], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43" + } + }, + { + "tags": [], + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L49" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", + "label": "authorizationError", + "description": [ + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L55" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/socket.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L66" + }, + "signature": [ + "Observable", + "" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L76" + }, + "signature": [ + "Observable", + "" + ] + } + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "label": "KibanaRequestRoute", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequestRoute", + "text": "KibanaRequestRoute" + }, + "" + ], + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L53" + } + }, + { + "tags": [], + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "label": "method", + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L54" + }, + "signature": [ + "Method" + ] + }, + { + "tags": [], + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "label": "options", + "description": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L55" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequestRouteOptions", + "text": "KibanaRequestRouteOptions" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IKibanaResponse", + "type": "Interface", + "label": "IKibanaResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.IKibanaResponse.status", + "type": "number", + "label": "status", + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L34" + } + }, + { + "tags": [], + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "label": "payload", + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L35" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "label": "options", + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L36" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ] + } + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyRequest", + "type": "Interface", + "label": "LegacyRequest", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " extends ", + "Request" + ], + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [], + "source": { + "path": "src/core/server/http/router/request.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L84" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "label": "OnPreAuthToolkit", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L44" + }, + "signature": [ + "() => Next" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreRoutingToolkit", + "type": "Interface", + "label": "OnPreRoutingToolkit", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L57" + }, + "signature": [ + "() => OnPreRoutingResult" + ] + }, + { + "tags": [], + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L59" + }, + "signature": [ + "(url: string) => OnPreRoutingResult" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "label": "OnPostAuthToolkit", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L44" + }, + "signature": [ + "() => Next" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "label": "render", + "description": [ + "To override the response with a different body" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L90" + }, + "signature": [ + "(responseRender: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + }, + ") => OnPreResponseResult" + ] + }, + { + "tags": [], + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L92" + }, + "signature": [ + "(responseExtensions?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined) => OnPreResponseResult" + ] + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L47" + }, + "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.OnPreResponseRender.body", + "type": "string", + "label": "body", + "description": [ + "the body to use in the response" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L49" + } + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L58" + }, + "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": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L66" + } + } + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteConfig", + "type": "Interface", + "label": "RouteConfig", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "description": [ + "\nRoute specific configuration." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "remarks" + ], + "id": "def-server.RouteConfig.path", + "type": "string", + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L171" + } + }, + { + "tags": [ + "remarks", + "example", + "kbn" + ], + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L229" + }, + "signature": [ + "false | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidatorFullConfig", + "text": "RouteValidatorFullConfig" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfig.options", + "type": "Object", + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L234" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L157" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IRouter", + "type": "Interface", + "label": "IRouter", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IRouter", + "text": "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.IRouter.routerPath", + "type": "string", + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L65" + } + }, + { + "tags": [ + "link", + "link" + ], + "id": "def-server.IRouter.get", + "type": "Function", + "label": "get", + "description": [ + "\nRegister a route handler for `GET` request." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L72" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" + }, + "<\"get\", Context>" + ] + }, + { + "tags": [ + "link", + "link" + ], + "id": "def-server.IRouter.post", + "type": "Function", + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L79" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" + }, + "<\"post\", Context>" + ] + }, + { + "tags": [ + "link", + "link" + ], + "id": "def-server.IRouter.put", + "type": "Function", + "label": "put", + "description": [ + "\nRegister a route handler for `PUT` request." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L86" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" + }, + "<\"put\", Context>" + ] + }, + { + "tags": [ + "link", + "link" + ], + "id": "def-server.IRouter.patch", + "type": "Function", + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L93" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" + }, + "<\"patch\", Context>" + ] + }, + { + "tags": [ + "link", + "link" + ], + "id": "def-server.IRouter.delete", + "type": "Function", + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L100" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteRegistrar", + "text": "RouteRegistrar" + }, + "<\"delete\", Context>" + ] + }, + { + "tags": [ + "link" + ], + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", + "label": "handleLegacyErrors", + "description": [ + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L106" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandlerWrapper", + "text": "RequestHandlerWrapper" + } + ] + } + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "label": "RouteConfigOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "" + ], + "description": [ + "\nAdditional route options." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "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 if has valid credentials or no credentials at all.\nCan 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." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L116" + }, + "signature": [ + "boolean | \"optional\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "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" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L125" + }, + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L130" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L135" + }, + "signature": [ + "(Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? undefined : ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfigOptionsBody", + "text": "RouteConfigOptionsBody" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L140" + }, + "signature": [ + "{ payload?: (Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L106" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteConfigOptionsBody", + "type": "Interface", + "label": "RouteConfigOptionsBody", + "description": [ + "\nAdditional body options for a route" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L68" + }, + "signature": [ + "string | string[] | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteContentType", + "text": "RouteContentType" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "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`." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L75" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L88" + }, + "signature": [ + "\"data\" | \"stream\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L99" + }, + "signature": [ + "boolean | \"gunzip\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidatorConfig", + "type": "Interface", + "label": "RouteValidatorConfig", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "public" + ], + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", + "label": "params", + "description": [ + "\nValidation logic for the URL params" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L92" + }, + "signature": [ + "ObjectType", + " | ", + "Type", + "

| ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + "

| undefined" + ] + }, + { + "tags": [ + "public" + ], + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "label": "query", + "description": [ + "\nValidation logic for the Query params" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L97" + }, + "signature": [ + "ObjectType", + " | ", + "Type", + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + " | undefined" + ] + }, + { + "tags": [ + "public" + ], + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L102" + }, + "signature": [ + "ObjectType", + " | ", + "Type", + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L87" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidatorOptions", + "type": "Interface", + "label": "RouteValidatorOptions", + "description": [ + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [ + "public" + ], + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", + "label": "unsafe", + "description": [ + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L115" + }, + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L110" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.RouteValidationResultFactory.ok", + "type": "Function", + "label": "ok", + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L21" + }, + "signature": [ + "(value: T) => { value: T; }" + ] + }, + { + "tags": [], + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", + "label": "badRequest", + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L22" + }, + "signature": [ + "(error: string | Error, path?: string[] | undefined) => { error: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ] + } + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SessionStorage", + "type": "Interface", + "label": "SessionStorage", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.SessionStorage.get", + "type": "Function", + "label": "get", + "signature": [ + "() => Promise" + ], + "description": [ + "\nRetrieves session value from the session storage." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L18" + } + }, + { + "id": "def-server.SessionStorage.set", + "type": "Function", + "label": "set", + "signature": [ + "(sessionValue: T) => void" + ], + "description": [ + "\nPuts current session value into the session storage." + ], + "children": [ + { + "type": "Uncategorized", + "label": "sessionValue", + "isRequired": true, + "signature": [ + "T" + ], + "description": [ + "- value to put" + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L23" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L23" + } + }, + { + "id": "def-server.SessionStorage.clear", + "type": "Function", + "label": "clear", + "signature": [ + "() => void" + ], + "description": [ + "\nClears current session." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L27" + } + } + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "label": "SessionStorageCookieOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", + "label": "name", + "description": [ + "\nName of the session cookie." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L24" + } + }, + { + "tags": [], + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", + "label": "encryptionKey", + "description": [ + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L28" + } + }, + { + "tags": [], + "id": "def-server.SessionStorageCookieOptions.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nFunction called to validate a cookie's decrypted value." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L32" + }, + "signature": [ + "(sessionValue: T | T[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionCookieValidationResult", + "text": "SessionCookieValidationResult" + } + ] + }, + { + "tags": [], + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", + "label": "isSecure", + "description": [ + "\nFlag indicating whether the cookie should be sent only via a secure connection." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L36" + } + }, + { + "tags": [], + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", + "label": "sameSite", + "description": [ + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L41" + }, + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L52" + } + }, + { + "tags": [], + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L56" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/http/cookie_session_storage.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "label": "SessionStorageFactory", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + "" + ], + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "label": "asScoped", + "description": [], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L34" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/http/session_storage.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L33" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-server.AuthStatus", + "type": "Enum", + "label": "AuthStatus", + "tags": [ + "public" + ], + "description": [ + "\nStatus indicating an outcome of the authentication." + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AuthResultType", + "type": "Enum", + "label": "AuthResultType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L22" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-server.AuthenticationHandler", + "type": "Type", + "label": "AuthenticationHandler", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link AuthToolkit}." + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L147" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.AuthHeaders", + "type": "Type", + "label": "AuthHeaders", + "tags": [ + "public" + ], + "description": [ + "\nAuth Headers map" + ], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L82" + }, + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AuthResult", + "type": "Type", + "label": "AuthResult", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/http/lifecycle/auth.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L44" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Authenticated", + "text": "Authenticated" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthNotHandled", + "text": "AuthNotHandled" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthRedirected", + "text": "AuthRedirected" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.IBasePath", + "type": "Type", + "label": "IBasePath", + "tags": [ + "public" + ], + "description": [ + "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" + ], + "source": { + "path": "src/core/server/http/base_path_service.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L104" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.GetAuthHeaders", + "type": "Type", + "label": "GetAuthHeaders", + "tags": [ + "link", + "return", + "public" + ], + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." + ], + "source": { + "path": "src/core/server/http/auth_headers_storage.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_headers_storage.ts#L18" + }, + "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" + }, + ") => Record | undefined" + ], + "initialIsOpen": false + }, + { + "id": "def-server.GetAuthState", + "type": "Type", + "label": "GetAuthState", + "tags": [ + "link", + "public" + ], + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L35" + }, + "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" + }, + ") => { status: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.Headers", + "type": "Type", + "label": "Headers", + "tags": [ + "public" + ], + "description": [ + "\nHttp request headers to read." + ], + "source": { + "path": "src/core/server/http/router/headers.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L40" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.HttpResponsePayload", + "type": "Type", + "label": "HttpResponsePayload", + "tags": [ + "public" + ], + "description": [ + "\nData send to the client as a response payload." + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L71" + }, + "signature": [ + "undefined | string | Record | Buffer | ", + "Stream" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IsAuthenticated", + "type": "Type", + "label": "IsAuthenticated", + "tags": [ + "link", + "public" + ], + "description": [ + "\nReturns authentication status for a request." + ], + "source": { + "path": "src/core/server/http/auth_state_storage.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L44" + }, + "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" + }, + ") => boolean" + ], + "initialIsOpen": false + }, + { + "id": "def-server.KibanaRequestRouteOptions", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L44" + }, + "signature": [ + "Method extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.LifecycleResponseFactory", + "type": "Type", + "label": "LifecycleResponseFactory", + "tags": [ + "public" + ], + "description": [ + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 325, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L325" + }, + "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>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.KnownHeaders", + "type": "Type", + "label": "KnownHeaders", + "tags": [ + "public" + ], + "description": [ + "\nSet of well-known HTTP headers." + ], + "source": { + "path": "src/core/server/http/router/headers.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L34" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.OnPreAuthHandler", + "type": "Type", + "label": "OnPreAuthHandler", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link OnPreAuthToolkit}." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L55" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.OnPreRoutingHandler", + "type": "Type", + "label": "OnPreRoutingHandler", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L71" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "label": "OnPostAuthHandler", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L51" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.OnPreResponseHandler", + "type": "Type", + "label": "OnPreResponseHandler", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "source": { + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L104" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", preResponse: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + }, + ", toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + }, + ") => Render | Next | Promise" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RedirectResponseOptions", + "type": "Type", + "label": "RedirectResponseOptions", + "tags": [ + "public" + ], + "description": [ + "\nHTTP response parameters for redirection response" + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L89" + }, + "signature": [ + "HttpResponseOptions & { headers: { location: string;}; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandler", + "type": "Type", + "label": "RequestHandler", + "tags": [ + "link", + "link", + "link", + "example", + "public" + ], + "description": [ + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 350, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L350" + }, + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandlerWrapper", + "type": "Type", + "label": "RequestHandlerWrapper", + "tags": [ + "example", + "public" + ], + "description": [ + "\nType-safe wrapper for {@link RequestHandler} function." + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 376, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L376" + }, + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandlerContextContainer", + "type": "Type", + "label": "RequestHandlerContextContainer", + "tags": [ + "public" + ], + "description": [ + "\nAn object that handles registration of http request context providers." + ], + "source": { + "path": "src/core/server/http/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L30" + }, + "signature": [ + "IContextContainer | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandlerContextProvider", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L38" + }, + "signature": [ + "(context: Pick>, rest: [request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | 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" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ResponseError", + "type": "Type", + "label": "ResponseError", + "tags": [ + "public" + ], + "description": [ + "\nError message and optional data send to the client in case of error." + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L21" + }, + "signature": [ + "string | Error | { message: string | Error; attributes?: Record | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ResponseErrorAttributes", + "type": "Type", + "label": "ResponseErrorAttributes", + "tags": [ + "public" + ], + "description": [ + "\nAdditional data to provide error details." + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L16" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ResponseHeaders", + "type": "Type", + "label": "ResponseHeaders", + "tags": [ + "public" + ], + "description": [ + "\nHttp response headers to set." + ], + "source": { + "path": "src/core/server/http/router/headers.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L48" + }, + "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" + ], + "initialIsOpen": false + }, + { + "id": "def-server.KibanaResponseFactory", + "type": "Type", + "label": "KibanaResponseFactory", + "tags": [ + "public" + ], + "description": [ + "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." + ], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L319" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteRegistrar", + "type": "Type", + "label": "RouteRegistrar", + "tags": [ + "public" + ], + "description": [ + "\nRoute handler common definition\n" + ], + "source": { + "path": "src/core/server/http/router/router.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L47" + }, + "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", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteMethod", + "type": "Type", + "label": "RouteMethod", + "tags": [ + "public" + ], + "description": [ + "\nThe set of common HTTP methods supported by Kibana routing." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L31" + }, + "signature": [ + "\"get\" | \"options\" | \"post\" | \"put\" | \"delete\" | \"patch\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteContentType", + "type": "Type", + "label": "RouteContentType", + "tags": [ + "public" + ], + "description": [ + "\nThe set of supported parseable Content-Types" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L43" + }, + "signature": [ + "\"application/json\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"multipart/form-data\" | \"text/*\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidationSpec", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L70" + }, + "signature": [ + "ObjectType", + " | ", + "Type", + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidationFunction", + "type": "Type", + "label": "RouteValidationFunction", + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L50" + }, + "signature": [ + "(data: any, validationResult: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + }, + ") => { value: T; error?: undefined; } | { value?: undefined; error: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.RouteValidatorFullConfig", + "type": "Type", + "label": "RouteValidatorFullConfig", + "tags": [ + "public" + ], + "description": [ + "\nRoute validations config and options merged into one object" + ], + "source": { + "path": "src/core/server/http/router/validator/validator.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L126" + }, + "signature": [ + "RouteValidatorConfig & RouteValidatorOptions" + ], + "initialIsOpen": false + }, + { + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "label": "DestructiveRouteMethod", + "tags": [ + "public" + ], + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L19" + }, + "signature": [ + "\"post\" | \"put\" | \"delete\" | \"patch\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SafeRouteMethod", + "type": "Type", + "label": "SafeRouteMethod", + "tags": [ + "public" + ], + "description": [ + "\nSet of HTTP methods not changing the state of the server." + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L25" + }, + "signature": [ + "\"get\" | \"options\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-server.kibanaResponseFactory", + "type": "Object", + "tags": [ + "example", + "public" + ], + "children": [ + { + "id": "def-server.kibanaResponseFactory.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 290, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L290" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.kibanaResponseFactory.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 291, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L291" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.kibanaResponseFactory.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L292" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.kibanaResponseFactory.custom", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L298" + } + } + ], + "signature": [ + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaResponse", + "text": "KibanaResponse" + }, + "" + ], + "description": [ + "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" + ], + "label": "custom", + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L297" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [ + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" + ], + "label": "kibanaResponseFactory", + "source": { + "path": "src/core/server/http/router/response.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L289" + }, + "initialIsOpen": false + }, + { + "tags": [ + "public" + ], + "id": "def-server.validBodyOutput", + "type": "Object", + "label": "validBodyOutput", + "description": [ + "\nThe set of valid body.output" + ], + "source": { + "path": "src/core/server/http/router/route.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L37" + }, + "signature": [ + "readonly [\"data\", \"stream\"]" + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx new file mode 100644 index 0000000000000..ea545eb6d70de --- /dev/null +++ b/api_docs/core_http.mdx @@ -0,0 +1,38 @@ +--- +id: kibCoreHttpPluginApi +slug: /kibana-dev-docs/core.httpPluginApi +title: core.http +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.http plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import coreHttpObj from './core_http.json'; + +## Client + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Objects + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json new file mode 100644 index 0000000000000..a108fda2c12e0 --- /dev/null +++ b/api_docs/core_saved_objects.json @@ -0,0 +1,14001 @@ +{ + "id": "core.savedObjects", + "client": { + "classes": [ + { + "id": "def-public.SavedObjectsClient", + "type": "Class", + "tags": [ + "public" + ], + "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" + ], + "children": [ + { + "id": "def-public.SavedObjectsClient.create", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L221" + } + }, + { + "type": "Uncategorized", + "label": "attributes", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L222" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L223" + } + } + ], + "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" + }, + ">" + ], + "description": [ + "\nPersists an object\n" + ], + "label": "create", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L220" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.SavedObjectsClient.bulkCreate", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L256" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L257" + } + } + ], + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "description": [ + "\nCreates multiple documents at once\n" + ], + "label": "bulkCreate", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L255" + }, + "tags": [ + "property" + ], + "returnComment": [ + "The result of the create operation containing created saved objects." + ] + }, + { + "id": "def-public.SavedObjectsClient.delete", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L284" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L285" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L286" + } + } + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined) => Promise<{}>" + ], + "description": [ + "\nDeletes an object\n" + ], + "label": "delete", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 283, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L283" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.SavedObjectsClient.find", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 314, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L314" + } + } + ], + "signature": [ + "(options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + ">" + ], + "description": [ + "\nSearch for objects\n" + ], + "label": "find", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L313" + }, + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "returnComment": [ + "A find result with objects matching the specified search." + ] + }, + { + "id": "def-public.SavedObjectsClient.get", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + } + } + ], + "signature": [ + "(type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "description": [ + "\nFetches a single object\n" + ], + "label": "get", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + }, + "tags": [], + "returnComment": [ + "The saved object for the given type and id." + ] + }, + { + "id": "def-public.SavedObjectsClient.bulkGet", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + "{ id: string; type: string; }[]" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" + } + } + ], + "signature": [ + "(objects?: { id: string; type: string; }[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "description": [ + "\nReturns an array of objects by id\n" + ], + "label": "bulkGet", + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" + }, + "tags": [ + "example" + ], + "returnComment": [ + "The saved objects with the given type and ids requested" + ] + }, + { + "id": "def-public.SavedObjectsClient.update", + "type": "Function", + "label": "update", + "signature": [ + "(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "description": [ + "\nUpdates an object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 427, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L427" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 428, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L428" + } + }, + { + "type": "Uncategorized", + "label": "attributes", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 429, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L429" + } + }, + { + "type": "Object", + "label": "{ version, migrationVersion, references }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 430, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L430" + } + } + ], + "tags": [ + "prop", + "prop" + ], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L426" + } + }, + { + "id": "def-public.SavedObjectsClient.bulkUpdate", + "type": "Function", + "label": "bulkUpdate", + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "description": [ + "\nUpdate multiple documents at once\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 458, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" + } + } + ], + "tags": [], + "returnComment": [ + "The result of the update operation containing both failed and updated saved objects." + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 458, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" + } + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L165" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SimpleSavedObject", + "type": "Class", + "tags": [ + "public" + ], + "label": "SimpleSavedObject", + "description": [ + "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.SimpleSavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L24" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject._version", + "type": "string", + "label": "_version", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L29" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L30" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L31" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L32" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ] + }, + { + "id": "def-public.SimpleSavedObject.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "client", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L35" + } + }, + { + "type": "Object", + "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L36" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L34" + } + }, + { + "id": "def-public.SimpleSavedObject.get", + "type": "Function", + "label": "get", + "signature": [ + "(key: string) => any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" + } + }, + { + "id": "def-public.SimpleSavedObject.set", + "type": "Function", + "label": "set", + "signature": [ + "(key: string, value: any) => T" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } + }, + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } + }, + { + "id": "def-public.SimpleSavedObject.has", + "type": "Function", + "label": "has", + "signature": [ + "(key: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + } + }, + { + "id": "def-public.SimpleSavedObject.save", + "type": "Function", + "label": "save", + "signature": [ + "() => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L71" + } + }, + { + "id": "def-public.SimpleSavedObject.delete", + "type": "Function", + "label": "delete", + "signature": [ + "() => Promise<{}>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L86" + } + } + ], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L23" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.SavedObjectsBatchResponse", + "type": "Interface", + "label": "SavedObjectsBatchResponse", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBatchResponse.savedObjects", + "type": "Array", + "label": "savedObjects", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L89" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "[]" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBulkCreateObject", + "type": "Interface", + "label": "SavedObjectsBulkCreateObject", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBulkCreateObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L55" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L56" + }, + "signature": [ + "T" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBulkCreateOptions", + "type": "Interface", + "label": "SavedObjectsBulkCreateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBulkCreateOptions.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L62" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBulkUpdateObject", + "type": "Interface", + "label": "SavedObjectsBulkUpdateObject", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L67" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L68" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L69" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L70" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L71" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L66" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "label": "SavedObjectsBulkUpdateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L76" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L75" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsCreateOptions", + "type": "Interface", + "label": "SavedObjectsCreateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.id", + "type": "string", + "label": "id", + "description": [ + "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L38" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L40" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L42" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L44" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L45" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsFindResponsePublic", + "type": "Interface", + "label": "SavedObjectsFindResponsePublic", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L107" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L108" + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L109" + } + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L106" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsUpdateOptions", + "type": "Interface", + "label": "SavedObjectsUpdateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsUpdateOptions.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L81" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsUpdateOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L83" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsUpdateOptions.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L84" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsStart", + "type": "Interface", + "label": "SavedObjectsStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsStart.client", + "type": "Object", + "label": "client", + "description": [ + "{@link SavedObjectsClient}" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_service.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L18" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_service.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L16" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.SavedObjectsClientContract", + "type": "Type", + "label": "SavedObjectsClientContract", + "tags": [ + "public" + ], + "description": [ + "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L138" + }, + "signature": [ + "{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; find: (options: Pick) => Promise>; update: (type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.SavedObjectsClient", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsClient", + "description": [ + "\n" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsClient.errors", + "type": "Object", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 397, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L397" + }, + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsClient.errors", + "type": "Object", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 398, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L398" + }, + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + } + ] + }, + { + "id": "def-server.SavedObjectsClient.create", + "type": "Function", + "label": "create", + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ], + "description": [ + "\nPersists a SavedObject\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414" + } + }, + { + "type": "Uncategorized", + "label": "attributes", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414" + } + }, + { + "id": "def-server.SavedObjectsClient.bulkCreate", + "type": "Function", + "label": "bulkCreate", + "signature": [ + "(objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "description": [ + "\nPersists multiple documents batched together as a single request\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 425, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L425" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L426" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 424, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L424" + } + }, + { + "id": "def-server.SavedObjectsClient.checkConflicts", + "type": "Function", + "label": "checkConflicts", + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">" + ], + "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" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 439, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L439" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 440, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L440" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 438, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L438" + } + }, + { + "id": "def-server.SavedObjectsClient.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>" + ], + "description": [ + "\nDeletes a SavedObject\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 452, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 452, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 452, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 452, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452" + } + }, + { + "id": "def-server.SavedObjectsClient.find", + "type": "Function", + "label": "find", + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">" + ], + "description": [ + "\nFind all SavedObjects matching the search query\n" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 461, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 461, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461" + } + }, + { + "id": "def-server.SavedObjectsClient.bulkGet", + "type": "Function", + "label": "bulkGet", + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "description": [ + "\nReturns an array of objects by id\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[]" + ], + "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": 477, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L477" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 478, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L478" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L476" + } + }, + { + "id": "def-server.SavedObjectsClient.get", + "type": "Function", + "label": "get", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ], + "description": [ + "\nRetrieves a single object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The type of SavedObject to retrieve" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 491, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L491" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 492, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L492" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 493, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L493" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 490, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L490" + } + }, + { + "id": "def-server.SavedObjectsClient.resolve", + "type": "Function", + "label": "resolve", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">" + ], + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The type of SavedObject to retrieve" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 506, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L506" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 507, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L507" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L508" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 505, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L505" + } + }, + { + "id": "def-server.SavedObjectsClient.update", + "type": "Function", + "label": "update", + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">" + ], + "description": [ + "\nUpdates an SavedObject\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L521" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 522, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L522" + } + }, + { + "type": "Object", + "label": "attributes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 523, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L523" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 524, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L524" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 520, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L520" + } + }, + { + "id": "def-server.SavedObjectsClient.addToNamespaces", + "type": "Function", + "label": "addToNamespaces", + "signature": [ + "(type: string, id: string, namespaces: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesResponse", + "text": "SavedObjectsAddToNamespacesResponse" + }, + ">" + ], + "description": [ + "\nAdds namespaces to a SavedObject\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 538, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L538" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 539, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L539" + } + }, + { + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 540, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L540" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 541, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L541" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 537, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L537" + } + }, + { + "id": "def-server.SavedObjectsClient.deleteFromNamespaces", + "type": "Function", + "label": "deleteFromNamespaces", + "signature": [ + "(type: string, id: string, namespaces: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesResponse", + "text": "SavedObjectsDeleteFromNamespacesResponse" + }, + ">" + ], + "description": [ + "\nRemoves namespaces from a SavedObject\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 555, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L555" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 556, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L556" + } + }, + { + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 557, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L557" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 558, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L558" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 554, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L554" + } + }, + { + "id": "def-server.SavedObjectsClient.bulkUpdate", + "type": "Function", + "label": "bulkUpdate", + "signature": [ + "(objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">" + ], + "description": [ + "\nBulk Updates multiple SavedObject at once\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 569, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L569" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 570, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L570" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 568, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L568" + } + }, + { + "id": "def-server.SavedObjectsClient.removeReferencesTo", + "type": "Function", + "label": "removeReferencesTo", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" + ], + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 579, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L579" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 580, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L580" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 581, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L581" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 578, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L578" + } + }, + { + "id": "def-server.SavedObjectsClient.openPointInTimeForType", + "type": "Function", + "label": "openPointInTimeForType", + "signature": [ + "(type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" + ], + "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." + ], + "children": [ + { + "type": "CompoundType", + "label": "type", + "isRequired": true, + "signature": [ + "string | string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 592, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L592" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 593, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L593" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 591, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L591" + } + }, + { + "id": "def-server.SavedObjectsClient.closePointInTime", + "type": "Function", + "label": "closePointInTime", + "signature": [ + "(id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">" + ], + "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}." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 603, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 603, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 603, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 396, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L396" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsErrorHelpers", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsErrorHelpers", + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError", + "type": "Function", + "label": "isSavedObjectsClientError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isSavedObjectsClientError" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "error", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError", + "type": "Function", + "label": "decorateBadRequestError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateBadRequestError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError", + "type": "Function", + "label": "createBadRequestError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createBadRequestError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError", + "type": "Function", + "label": "createUnsupportedTypeError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createUnsupportedTypeError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError", + "type": "Function", + "label": "isBadRequestError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isBadRequestError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError", + "type": "Function", + "label": "createInvalidVersionError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createInvalidVersionError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "versionInput", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError", + "type": "Function", + "label": "isInvalidVersionError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isInvalidVersionError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError", + "type": "Function", + "label": "decorateNotAuthorizedError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateNotAuthorizedError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError", + "type": "Function", + "label": "isNotAuthorizedError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isNotAuthorizedError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError", + "type": "Function", + "label": "decorateForbiddenError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateForbiddenError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError", + "type": "Function", + "label": "isForbiddenError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isForbiddenError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError", + "type": "Function", + "label": "decorateRequestEntityTooLargeError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateRequestEntityTooLargeError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError", + "type": "Function", + "label": "isRequestEntityTooLargeError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isRequestEntityTooLargeError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError", + "type": "Function", + "label": "createGenericNotFoundError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createGenericNotFoundError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "type", + "isRequired": false, + "signature": [ + "string | null" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131" + } + }, + { + "type": "CompoundType", + "label": "id", + "isRequired": false, + "signature": [ + "string | null" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError", + "type": "Function", + "label": "createIndexAliasNotFoundError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createIndexAliasNotFoundError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "alias", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError", + "type": "Function", + "label": "decorateIndexAliasNotFoundError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateIndexAliasNotFoundError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142" + } + }, + { + "type": "string", + "label": "alias", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError", + "type": "Function", + "label": "isNotFoundError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isNotFoundError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError", + "type": "Function", + "label": "decorateConflictError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateConflictError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createConflictError", + "type": "Function", + "label": "createConflictError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createConflictError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isConflictError", + "type": "Function", + "label": "isConflictError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isConflictError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError", + "type": "Function", + "label": "decorateTooManyRequestsError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateTooManyRequestsError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError", + "type": "Function", + "label": "createTooManyRequestsError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".createTooManyRequestsError" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError", + "type": "Function", + "label": "isTooManyRequestsError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isTooManyRequestsError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError", + "type": "Function", + "label": "decorateEsCannotExecuteScriptError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateEsCannotExecuteScriptError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError", + "type": "Function", + "label": "isEsCannotExecuteScriptError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isEsCannotExecuteScriptError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError", + "type": "Function", + "label": "decorateEsUnavailableError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateEsUnavailableError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", + "type": "Function", + "label": "isEsUnavailableError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isEsUnavailableError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", + "type": "Function", + "label": "decorateGeneralError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".decorateGeneralError" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198" + } + }, + { + "type": "string", + "label": "reason", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198" + } + }, + { + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", + "type": "Function", + "label": "isGeneralError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isGeneralError" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L72" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsSerializer", + "type": "Class", + "tags": [ + "remarks", + "public" + ], + "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" + ], + "children": [ + { + "id": "def-server.SavedObjectsSerializer.isRawSavedObject", + "type": "Function", + "label": "isRawSavedObject", + "signature": [ + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + }, + ") => boolean" + ], + "description": [ + "\nDetermines whether or not the raw document can be converted to a saved object.\n" + ], + "children": [ + { + "type": "Object", + "label": "doc", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } + ], + "description": [ + "- The raw ES document to be tested" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } + ], + "description": [ + "- Options for parsing the raw document." + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41" + } + }, + { + "id": "def-server.SavedObjectsSerializer.rawToSavedObject", + "type": "Function", + "label": "rawToSavedObject", + "signature": [ + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + "" + ], + "description": [ + "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + ], + "children": [ + { + "type": "Object", + "label": "doc", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } + ], + "description": [ + "- The raw ES document to be converted to saved object format." + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L59" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } + ], + "description": [ + "- Options for parsing the raw document." + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L60" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L58" + } + }, + { + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", + "type": "Function", + "label": "savedObjectToRaw", + "signature": [ + "(savedObj: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } + ], + "description": [ + "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "savedObj", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + "" + ], + "description": [ + "- The saved object to be converted to raw ES format." + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102" + } + }, + { + "id": "def-server.SavedObjectsSerializer.generateRawId", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "- The namespace of the saved object" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143" + } + }, + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The saved object type" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The id of the saved object" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143" + } + }, + { + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The namespace of the saved object" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156" + } + }, + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The saved object type" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The id of the saved object" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRepository", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsRepository", + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsRepository.create", + "type": "Function", + "label": "create", + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ], + "description": [ + "\nPersists an object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L237" + } + }, + { + "type": "Uncategorized", + "label": "attributes", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L238" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L239" + } + } + ], + "tags": [ + "property", + "property", + "property", + "property", + "property" + ], + "returnComment": [ + "- { id, type, version, attributes }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L236" + } + }, + { + "id": "def-server.SavedObjectsRepository.bulkCreate", + "type": "Function", + "label": "bulkCreate", + "signature": [ + "(objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "description": [ + "\nCreates multiple documents at once\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 330, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L330" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L331" + } + } + ], + "tags": [ + "property", + "property" + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 329, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L329" + } + }, + { + "id": "def-server.SavedObjectsRepository.checkConflicts", + "type": "Function", + "label": "checkConflicts", + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">" + ], + "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." + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 517, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L517" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 518, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L518" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 516, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L516" + } + }, + { + "id": "def-server.SavedObjectsRepository.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>" + ], + "description": [ + "\nDeletes an object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + } + } + ], + "tags": [ + "property" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + } + }, + { + "id": "def-server.SavedObjectsRepository.deleteByNamespace", + "type": "Function", + "label": "deleteByNamespace", + "signature": [ + "(namespace: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + ") => Promise" + ], + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 664, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L664" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 665, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L665" + } + } + ], + "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": 663, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L663" + } + }, + { + "id": "def-server.SavedObjectsRepository.find", + "type": "Function", + "label": "find", + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "options", + "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/repository.ts", + "lineNumber": 725, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" + } + } + ], + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 725, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" + } + }, + { + "id": "def-server.SavedObjectsRepository.bulkGet", + "type": "Function", + "label": "bulkGet", + "signature": [ + "(objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "description": [ + "\nReturns an array of objects by id\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[]" + ], + "description": [ + "- an array of objects containing id, type and optionally fields" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 875, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L875" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 876, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L876" + } + } + ], + "tags": [ + "property", + "example" + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }] }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 874, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L874" + } + }, + { + "id": "def-server.SavedObjectsRepository.get", + "type": "Function", + "label": "get", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ], + "description": [ + "\nGets a single object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 960, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L960" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 961, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L961" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 962, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L962" + } + } + ], + "tags": [ + "property" + ], + "returnComment": [ + "- { id, type, version, attributes }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 959, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L959" + } + }, + { + "id": "def-server.SavedObjectsRepository.resolve", + "type": "Function", + "label": "resolve", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">" + ], + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 998, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L998" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 999, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L999" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1000, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1000" + } + } + ], + "tags": [ + "property" + ], + "returnComment": [ + "- { saved_object, outcome }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 997, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L997" + } + }, + { + "id": "def-server.SavedObjectsRepository.update", + "type": "Function", + "label": "update", + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">" + ], + "description": [ + "\nUpdates an object\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1117" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1118" + } + }, + { + "type": "Object", + "label": "attributes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1119" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1120" + } + } + ], + "tags": [ + "property", + "property", + "property" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1116" + } + }, + { + "id": "def-server.SavedObjectsRepository.addToNamespaces", + "type": "Function", + "label": "addToNamespaces", + "signature": [ + "(type: string, id: string, namespaces: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesResponse", + "text": "SavedObjectsAddToNamespacesResponse" + }, + ">" + ], + "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." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1190" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1191, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1191" + } + }, + { + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1192" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1193" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1189" + } + }, + { + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces", + "type": "Function", + "label": "deleteFromNamespaces", + "signature": [ + "(type: string, id: string, namespaces: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesResponse", + "text": "SavedObjectsDeleteFromNamespacesResponse" + }, + ">" + ], + "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." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1253" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1254" + } + }, + { + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1255" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1256" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1252" + } + }, + { + "id": "def-server.SavedObjectsRepository.bulkUpdate", + "type": "Function", + "label": "bulkUpdate", + "signature": [ + "(objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">" + ], + "description": [ + "\nUpdates multiple objects in bulk\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1358, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1358" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1359, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1359" + } + } + ], + "tags": [ + "property", + "property" + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1357, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1357" + } + }, + { + "id": "def-server.SavedObjectsRepository.removeReferencesTo", + "type": "Function", + "label": "removeReferencesTo", + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" + ], + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1573, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1573" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1574, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1574" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1575, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1575" + } + } + ], + "tags": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1572, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1572" + } + }, + { + "id": "def-server.SavedObjectsRepository.incrementCounter", + "type": "Function", + "label": "incrementCounter", + "signature": [ + "(type: string, id: string, counterFields: (string | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "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" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The type of saved object whose fields should be incremented" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1670, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1670" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The id of the document whose fields should be incremented" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1671, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1671" + } + }, + { + "type": "Array", + "label": "counterFields", + "isRequired": true, + "signature": [ + "(string | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[]" + ], + "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": 1672, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1672" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + } + ], + "description": [ + "- {@link SavedObjectsIncrementCounterOptions}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1673, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1673" + } + } + ], + "tags": [ + "remarks", + "example" + ], + "returnComment": [ + "The saved object after the specified fields were incremented" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1669, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1669" + } + }, + { + "id": "def-server.SavedObjectsRepository.openPointInTimeForType", + "type": "Function", + "label": "openPointInTimeForType", + "signature": [ + "(type: string | string[], { keepAlive, preference }?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" + ], + "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" + ], + "children": [ + { + "type": "CompoundType", + "label": "type", + "isRequired": true, + "signature": [ + "string | string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1821, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1821" + } + }, + { + "type": "Object", + "label": "{ keepAlive = '5m', preference }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1822, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1822" + } + } + ], + "tags": [ + "example", + "property", + "property" + ], + "returnComment": [ + "- { id: string }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1820, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1820" + } + }, + { + "id": "def-server.SavedObjectsRepository.closePointInTime", + "type": "Function", + "label": "closePointInTime", + "signature": [ + "(id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">" + ], + "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" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1890, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1890" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "description": [ + "- {@link SavedObjectsClosePointInTimeOptions}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1891, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1891" + } + } + ], + "tags": [ + "remarks", + "example" + ], + "returnComment": [ + "- {@link SavedObjectsClosePointInTimeResponse}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1889, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1889" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L143" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectTypeRegistry", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectTypeRegistry", + "description": [ + "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + ], + "children": [ + { + "id": "def-server.SavedObjectTypeRegistry.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(type: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => 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." + ], + "children": [ + { + "type": "Object", + "label": "type", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(type: string) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined" + ], + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", + "type": "Function", + "label": "getVisibleTypes", + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L51" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getAllTypes", + "type": "Function", + "label": "getAllTypes", + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L60" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", + "type": "Function", + "label": "getImportableAndExportableTypes", + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]" + ], + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L67" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", + "type": "Function", + "label": "isNamespaceAgnostic", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", + "type": "Function", + "label": "isSingleNamespace", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isShareable", + "type": "Function", + "label": "isShareable", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isHidden", + "type": "Function", + "label": "isHidden", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getIndex", + "type": "Function", + "label": "getIndex", + "signature": [ + "(type: string) => string | undefined" + ], + "description": [ + "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "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." + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsUtils", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsUtils", + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsUtils.namespaceIdToString", + "type": "Function", + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.SavedObjectsUtils.namespaceStringToId", + "type": "Function", + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" + } + } + ], + "signature": [ + "({ page, perPage, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + "" + ], + "description": [ + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + ], + "label": "createEmptyFindResponse", + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.SavedObjectsUtils.generateId", + "type": "Function", + "label": "generateId", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" + }, + ".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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L67" + } + }, + { + "id": "def-server.SavedObjectsUtils.isRandomId", + "type": "Function", + "label": "isRandomId", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" + }, + ".isRandomId" + ], + "description": [ + "\nValidates that a saved object ID has been randomly generated.\n" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "The ID of a saved object." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" + } + } + ], + "tags": [ + "todo" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExporter", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsExporter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#savedObjectsClient", + "type": "Object", + "label": "#savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L38" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#exportTransforms", + "type": "Object", + "label": "#exportTransforms", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L39" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#exportSizeLimit", + "type": "number", + "label": "#exportSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L40" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#log", + "type": "Object", + "label": "#log", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L41" + }, + "signature": [ + "Logger" + ] + }, + { + "id": "def-server.SavedObjectsExporter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", + "type": "Object", + "label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.savedObjectsClient", + "type": "Object", + "label": "savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L49" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.typeRegistry", + "type": "Object", + "label": "typeRegistry", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L50" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.exportSizeLimit", + "type": "number", + "label": "exportSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L51" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.logger", + "type": "Object", + "label": "logger", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L52" + }, + "signature": [ + "Logger" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L43" + } + }, + { + "id": "def-server.SavedObjectsExporter.exportByTypes", + "type": "Function", + "label": "exportByTypes", + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + }, + ") => Promise<", + "Readable", + ">" + ], + "description": [ + "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75" + } + } + ], + "tags": [ + "throws" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75" + } + }, + { + "id": "def-server.SavedObjectsExporter.exportByObjects", + "type": "Function", + "label": "exportByObjects", + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + ") => Promise<", + "Readable", + ">" + ], + "description": [ + "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93" + } + } + ], + "tags": [ + "throws" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportError", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsExportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-server.SavedObjectsExportError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L16" + } + }, + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L17" + } + }, + { + "type": "Object", + "label": "attributes", + "isRequired": false, + "signature": [ + "Record | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L15" + } + }, + { + "id": "def-server.SavedObjectsExportError.exportSizeExceeded", + "type": "Function", + "label": "exportSizeExceeded", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".exportSizeExceeded" + ], + "description": [], + "children": [ + { + "type": "number", + "label": "limit", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27" + } + }, + { + "id": "def-server.SavedObjectsExportError.objectFetchError", + "type": "Function", + "label": "objectFetchError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".objectFetchError" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34" + } + }, + { + "id": "def-server.SavedObjectsExportError.objectTransformError", + "type": "Function", + "label": "objectTransformError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".objectTransformError" + ], + "description": [ + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43" + } + }, + { + "type": "Object", + "label": "cause", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43" + } + }, + { + "id": "def-server.SavedObjectsExportError.invalidTransformError", + "type": "Function", + "label": "invalidTransformError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".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." + ], + "children": [ + { + "type": "Array", + "label": "objectKeys", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImporter", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsImporter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#savedObjectsClient", + "type": "Object", + "label": "#savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L30" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#typeRegistry", + "type": "Object", + "label": "#typeRegistry", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L31" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#importSizeLimit", + "type": "number", + "label": "#importSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L32" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#importHooks", + "type": "Object", + "label": "#importHooks", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L33" + }, + "signature": [ + "Record[]>" + ] + }, + { + "id": "def-server.SavedObjectsImporter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "type": "Object", + "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.savedObjectsClient", + "type": "Object", + "label": "savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L40" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.typeRegistry", + "type": "Object", + "label": "typeRegistry", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L41" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.importSizeLimit", + "type": "number", + "label": "importSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L42" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L39" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L35" + } + }, + { + "id": "def-server.SavedObjectsImporter.import", + "type": "Function", + "label": "import", + "signature": [ + "({ readStream, createNewCopies, namespace, overwrite, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" + ], + "description": [ + "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + ], + "children": [ + { + "type": "Object", + "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64" + } + } + ], + "tags": [ + "throws" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64" + } + }, + { + "id": "def-server.SavedObjectsImporter.resolveImportErrors", + "type": "Function", + "label": "resolveImportErrors", + "signature": [ + "({ readStream, createNewCopies, namespace, retries, }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportResponse", + "text": "SavedObjectsImportResponse" + }, + ">" + ], + "description": [ + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" + ], + "children": [ + { + "type": "Object", + "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88" + } + } + ], + "tags": [ + "throws" + ], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportError", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsImportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "type": "Function", + "label": "importSizeExceeded", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + ".importSizeExceeded" + ], + "description": [], + "children": [ + { + "type": "number", + "label": "limit", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27" + } + }, + { + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", + "type": "Function", + "label": "nonUniqueImportObjects", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + ".nonUniqueImportObjects" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "nonUniqueEntries", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34" + } + }, + { + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "type": "Function", + "label": "nonUniqueRetryObjects", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + ".nonUniqueRetryObjects" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "nonUniqueRetryObjects", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41" + } + }, + { + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "type": "Function", + "label": "nonUniqueRetryDestinations", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + ".nonUniqueRetryDestinations" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "nonUniqueRetryDestinations", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48" + } + }, + { + "id": "def-server.SavedObjectsImportError.referencesFetchError", + "type": "Function", + "label": "referencesFetchError", + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + ".referencesFetchError" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L14" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-server.SavedObjectsBulkCreateObject", + "type": "Interface", + "label": "SavedObjectsBulkCreateObject", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L66" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L67" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L68" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L69" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L70" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L72" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", + "type": "string", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L82" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.originId", + "type": "string", + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L84" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L91" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkGetObject", + "type": "Interface", + "label": "SavedObjectsBulkGetObject", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkGetObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L294" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkGetObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 295, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L295" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkGetObject.fields", + "type": "Array", + "label": "fields", + "description": [ + "SavedObject fields to include in the response" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L297" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L293" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkUpdateObject", + "type": "Interface", + "label": "SavedObjectsBulkUpdateObject", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + " extends Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ", \"version\" | \"references\">" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateObject.id", + "type": "string", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L101" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateObject.type", + "type": "string", + "label": "type", + "description": [ + " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L103" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateObject.attributes", + "type": "Object", + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L105" + }, + "signature": [ + "Partial" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateObject.namespace", + "type": "string", + "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`." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L112" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L98" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "label": "SavedObjectsBulkUpdateOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 275, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L275" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 273, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L273" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkResponse", + "type": "Interface", + "label": "SavedObjectsBulkResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", + "label": "saved_objects", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L120" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L119" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkResponse", + "type": "Interface", + "label": "SavedObjectsBulkResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", + "label": "saved_objects", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 305, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L305" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L304" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkUpdateResponse", + "type": "Interface", + "label": "SavedObjectsBulkUpdateResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", + "type": "Array", + "label": "saved_objects", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L313" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L312" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCheckConflictsObject", + "type": "Interface", + "label": "SavedObjectsCheckConflictsObject", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsCheckConflictsObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L184" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L185" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L183" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCheckConflictsResponse", + "type": "Interface", + "label": "SavedObjectsCheckConflictsResponse", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L193" + }, + "signature": [ + "{ id: string; type: string; error: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + "; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L192" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClientProviderOptions", + "type": "Interface", + "label": "SavedObjectsClientProviderOptions", + "description": [ + "\nOptions to control the creation of the Saved Objects Client." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", + "type": "Array", + "label": "excludedWrappers", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L58" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", + "type": "Array", + "label": "includedHiddenTypes", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L59" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClientWrapperOptions", + "type": "Interface", + "label": "SavedObjectsClientWrapperOptions", + "description": [ + "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsClientWrapperOptions.client", + "type": "Object", + "label": "client", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L20" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", + "type": "Object", + "label": "typeRegistry", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L21" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsClientWrapperOptions.request", + "type": "Object", + "label": "request", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L22" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClosePointInTimeResponse", + "type": "Interface", + "label": "SavedObjectsClosePointInTimeResponse", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", + "type": "boolean", + "label": "succeeded", + "description": [ + "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 385, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L385" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", + "type": "number", + "label": "num_freed", + "description": [ + "\nThe number of search contexts that have been successfully closed." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 389, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L389" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 380, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L380" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCreateOptions", + "type": "Interface", + "label": "SavedObjectsCreateOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.id", + "type": "string", + "label": "id", + "description": [ + "(not recommended) Specify an id for the document" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "Overwrite existing documents (defaults to false)" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L29" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.version", + "type": "string", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L34" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L36" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L46" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L47" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L49" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.originId", + "type": "string", + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L51" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L58" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportResultDetails", + "type": "Interface", + "label": "SavedObjectsExportResultDetails", + "description": [ + "\nStructure of the export result details entry" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExportResultDetails.exportedCount", + "type": "number", + "label": "exportedCount", + "description": [ + "number of successfully exported objects" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L59" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", + "type": "number", + "label": "missingRefCount", + "description": [ + "number of missing references" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L61" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsExportResultDetails.missingReferences", + "type": "Array", + "label": "missingReferences", + "description": [ + "missing references details" + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L63" + }, + "signature": [ + "{ id: string; type: string; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindResult", + "type": "Interface", + "label": "SavedObjectsFindResult", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" + }, + " extends ", + "SavedObject", + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsFindResult.score", + "type": "number", + "label": "score", + "description": [ + "\nThe Elasticsearch `_score` of this result." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L131" + } + }, + { + "tags": [ + "remarks", + "example" + ], + "id": "def-server.SavedObjectsFindResult.sort", + "type": "Array", + "label": "sort", + "description": [ + "\nThe Elasticsearch `sort` value of this result.\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L160" + }, + "signature": [ + "unknown[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L127" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindResponse", + "type": "Interface", + "label": "SavedObjectsFindResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + "" + ], + "description": [ + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.saved_objects", + "type": "Array", + "label": "saved_objects", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L172" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L173" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.per_page", + "type": "number", + "label": "per_page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L174" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L175" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.pit_id", + "type": "string", + "label": "pit_id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L176" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L171" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportConflictError", + "type": "Interface", + "label": "SavedObjectsImportConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportConflictError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L45" + }, + "signature": [ + "\"conflict\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportConflictError.destinationId", + "type": "string", + "label": "destinationId", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L46" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", + "label": "SavedObjectsImportAmbiguousConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L54" + }, + "signature": [ + "\"ambiguous_conflict\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "label": "destinations", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L55" + }, + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportFailure", + "type": "Interface", + "label": "SavedObjectsImportFailure", + "description": [ + "\nRepresents a failure to import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L91" + } + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.SavedObjectsImportFailure.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L95" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L96" + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L100" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L101" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportMissingReferencesError", + "type": "Interface", + "label": "SavedObjectsImportMissingReferencesError", + "description": [ + "\nRepresents a failure to import due to missing references." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L81" + }, + "signature": [ + "\"missing_references\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L82" + }, + "signature": [ + "{ type: string; id: string; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportOptions", + "type": "Interface", + "label": "SavedObjectsImportOptions", + "description": [ + "\nOptions to control the import operation." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportOptions.readStream", + "type": "Object", + "label": "readStream", + "description": [ + "The stream of {@link SavedObject | saved objects} to import" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L155" + }, + "signature": [ + "Readable" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportOptions.overwrite", + "type": "boolean", + "label": "overwrite", + "description": [ + "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L157" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportOptions.namespace", + "type": "string", + "label": "namespace", + "description": [ + "if specified, will import in given namespace, else will import as global object" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L159" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportOptions.createNewCopies", + "type": "boolean", + "label": "createNewCopies", + "description": [ + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L161" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L153" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportResponse", + "type": "Interface", + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.successCount", + "type": "number", + "label": "successCount", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L143" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.successResults", + "type": "Array", + "label": "successResults", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.warnings", + "type": "Array", + "label": "warnings", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L145" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.errors", + "type": "Array", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L146" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L141" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportRetry", + "type": "Interface", + "label": "SavedObjectsImportRetry", + "description": [ + "\nDescribes a retry operation for importing a saved object." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L17" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L18" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "label": "overwrite", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L19" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.destinationId", + "type": "string", + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L23" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "label": "replaceReferences", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24" + }, + "signature": [ + "{ type: string; from: string; to: string; }[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L33" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L37" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportSuccess", + "type": "Interface", + "label": "SavedObjectsImportSuccess", + "description": [ + "\nRepresents a successful import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L114" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L115" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.destinationId", + "type": "string", + "label": "destinationId", + "description": [ + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "label": "createNewCopy", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L126" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L127" + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L134" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L113" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportUnknownError", + "type": "Interface", + "label": "SavedObjectsImportUnknownError", + "description": [ + "\nRepresents a failure to import due to an unknown reason." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportUnknownError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L71" + }, + "signature": [ + "\"unknown\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportUnknownError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L72" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L73" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", + "label": "SavedObjectsImportUnsupportedTypeError", + "description": [ + "\nRepresents a failure to import due to having an unsupported saved object type." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L63" + }, + "signature": [ + "\"unsupported_type\"" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectMigrationContext", + "type": "Interface", + "label": "SavedObjectMigrationContext", + "description": [ + "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectMigrationContext.log", + "type": "Object", + "label": "log", + "description": [ + "\nlogger instance to be used by the migration handler" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L59" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMigrationLogger", + "text": "SavedObjectsMigrationLogger" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectMigrationContext.migrationVersion", + "type": "string", + "label": "migrationVersion", + "description": [ + "\nThe migration version that this migration function is defined for" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L63" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", + "type": "string", + "label": "convertToMultiNamespaceTypeVersion", + "description": [ + "\nThe version in which this object type is being converted to a multi-namespace type" + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L67" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsMigrationLogger", + "type": "Interface", + "label": "SavedObjectsMigrationLogger", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsMigrationLogger.debug", + "type": "Function", + "label": "debug", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L20" + }, + "signature": [ + "(msg: string) => void" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsMigrationLogger.info", + "type": "Function", + "label": "info", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L21" + }, + "signature": [ + "(msg: string) => void" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", + "label": "warning", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L25" + }, + "signature": [ + "(msg: string) => void" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsMigrationLogger.warn", + "type": "Function", + "label": "warn", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L26" + }, + "signature": [ + "(msg: string) => void" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsMigrationLogger.error", + "type": "Function", + "label": "error", + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L27" + }, + "signature": [ + "(msg: string, meta: ", + "LogMeta", + ") => void" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsOpenPointInTimeOptions", + "type": "Interface", + "label": "SavedObjectsOpenPointInTimeOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "type": "string", + "label": "keepAlive", + "description": [ + "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 355, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L355" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", + "label": "preference", + "description": [ + "\nAn optional ES preference value to be used for the query." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 359, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L359" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 351, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L351" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsOpenPointInTimeResponse", + "type": "Interface", + "label": "SavedObjectsOpenPointInTimeResponse", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", + "label": "id", + "description": [ + "\nPIT ID returned from ES." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L369" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 365, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L365" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRawDoc", + "type": "Interface", + "label": "SavedObjectsRawDoc", + "description": [ + "\nA raw document as represented directly in the saved object index.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsRawDoc._id", + "type": "string", + "label": "_id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L17" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsRawDoc._source", + "type": "Object", + "label": "_source", + "description": [], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L18" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocSource", + "text": "SavedObjectsRawDocSource" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsRawDoc._seq_no", + "type": "number", + "label": "_seq_no", + "description": [], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L19" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsRawDoc._primary_term", + "type": "number", + "label": "_primary_term", + "description": [], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L20" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRawDocParseOptions", + "type": "Interface", + "label": "SavedObjectsRawDocParseOptions", + "description": [ + "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", + "type": "CompoundType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L86" + }, + "signature": [ + "\"strict\" | \"lax\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L78" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRepositoryFactory", + "type": "Interface", + "label": "SavedObjectsRepositoryFactory", + "description": [ + "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L234" + }, + "signature": [ + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L244" + }, + "signature": [ + "(includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L226" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsResolveImportErrorsOptions", + "type": "Interface", + "label": "SavedObjectsResolveImportErrorsOptions", + "description": [ + "\nOptions to control the \"resolve import\" operation." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", + "type": "Object", + "label": "readStream", + "description": [ + "The stream of {@link SavedObject | saved objects} to resolve errors from" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L170" + }, + "signature": [ + "Readable" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "type": "Array", + "label": "retries", + "description": [ + "saved object import references to retry" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L172" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportRetry", + "text": "SavedObjectsImportRetry" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "type": "string", + "label": "namespace", + "description": [ + "if specified, will import in given namespace" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L174" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", + "type": "boolean", + "label": "createNewCopies", + "description": [ + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L176" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L168" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsResolveResponse", + "type": "Interface", + "label": "SavedObjectsResolveResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + "" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "label": "saved_object", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L331" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsResolveResponse.outcome", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 341, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L341" + }, + "signature": [ + "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", + "type": "string", + "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'`." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 345, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L345" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 330, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L330" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsUpdateOptions", + "type": "Interface", + "label": "SavedObjectsUpdateOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsUpdateOptions.version", + "type": "string", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L206" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsUpdateOptions.references", + "type": "Array", + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L208" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsUpdateOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L210" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L204" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsUpdateResponse", + "type": "Interface", + "label": "SavedObjectsUpdateResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + " extends Pick<", + "SavedObject", + ", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">" + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsUpdateResponse.attributes", + "type": "Object", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 322, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L322" + }, + "signature": [ + "Partial" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsUpdateResponse.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 323, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L323" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 320, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L320" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsAddToNamespacesOptions", + "type": "Interface", + "label": "SavedObjectsAddToNamespacesOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsAddToNamespacesOptions.version", + "type": "string", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L219" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsAddToNamespacesOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L221" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L217" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsAddToNamespacesResponse", + "type": "Interface", + "label": "SavedObjectsAddToNamespacesResponse", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsAddToNamespacesResponse.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "The namespaces the object exists in after this operation is complete." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L230" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L228" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "type": "Interface", + "label": "SavedObjectsDeleteFromNamespacesOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsDeleteFromNamespacesOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L239" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L237" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsDeleteFromNamespacesResponse", + "type": "Interface", + "label": "SavedObjectsDeleteFromNamespacesResponse", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsDeleteFromNamespacesResponse.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "The namespaces the object exists in after this operation is complete. An empty array indicates the object was deleted." + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L248" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L246" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRemoveReferencesToOptions", + "type": "Interface", + "label": "SavedObjectsRemoveReferencesToOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L257" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L255" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "type": "Interface", + "label": "SavedObjectsRemoveReferencesToResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", + "label": "updated", + "description": [ + "The number of objects that have been updated by this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L266" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L264" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsServiceStart", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.getScopedClient", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L172" + }, + "signature": [ + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.SavedObjectsServiceStart.createScopedRepository", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L188" + }, + "signature": [ + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.createInternalRepository", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L198" + }, + "signature": [ + "(includedHiddenTypes?: string[] | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.createSerializer", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L202" + }, + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsSerializer", + "text": "SavedObjectsSerializer" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.createExporter", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L206" + }, + "signature": [ + "(client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExporter", + "text": "SavedObjectsExporter" + }, + ", \"exportByTypes\" | \"exportByObjects\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.createImporter", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L210" + }, + "signature": [ + "(client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImporter", + "text": "SavedObjectsImporter" + }, + ", \"import\" | \"resolveImportErrors\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L215" + }, + "signature": [ + "() => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "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": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L162" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsServiceSetup", + "type": "Interface", + "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": [ + "remarks", + "example", + "example", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L90" + }, + "signature": [ + "(clientFactoryProvider: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L95" + }, + "signature": [ + "(priority: number, id: string, factory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + }, + ") => void" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.SavedObjectsServiceSetup.registerType", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L144" + }, + "signature": [ + "(type: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => void" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L85" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectStatusMeta", + "type": "Interface", + "label": "SavedObjectStatusMeta", + "description": [ + "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectStatusMeta.migratedIndices", + "type": "Object", + "label": "migratedIndices", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L50" + }, + "signature": [ + "{ [status: string]: number; skipped: number; migrated: number; }" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsDeleteOptions", + "type": "Interface", + "label": "SavedObjectsDeleteOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsDeleteOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L284" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsDeleteOptions.force", + "type": "CompoundType", + "label": "force", + "description": [ + "Force deletion of an object that exists in multiple namespaces" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L286" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L282" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsDeleteByNamespaceOptions", + "type": "Interface", + "label": "SavedObjectsDeleteByNamespaceOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch supports only boolean flag for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L118" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L116" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsIncrementCounterOptions", + "type": "Interface", + "label": "SavedObjectsIncrementCounterOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L102" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@link SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L104" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L109" + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsIncrementCounterField", + "type": "Interface", + "label": "SavedObjectsIncrementCounterField", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsIncrementCounterField.fieldName", + "type": "string", + "label": "fieldName", + "description": [ + "The field name to increment the counter by." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L135" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", + "type": "number", + "label": "incrementBy", + "description": [ + "The number to increment the field by (defaults to 1)." + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L137" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L133" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsComplexFieldMapping", + "type": "Interface", + "label": "SavedObjectsComplexFieldMapping", + "description": [ + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsComplexFieldMapping.dynamic", + "type": "CompoundType", + "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`." + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L150" + }, + "signature": [ + "false | \"strict\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsComplexFieldMapping.enabled", + "type": "CompoundType", + "label": "enabled", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L151" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", + "type": "CompoundType", + "label": "doc_values", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L152" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsComplexFieldMapping.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L153" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsComplexFieldMapping.properties", + "type": "Object", + "label": "properties", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L154" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L141" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCoreFieldMapping", + "type": "Interface", + "label": "SavedObjectsCoreFieldMapping", + "description": [ + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsCoreFieldMapping.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L124" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsCoreFieldMapping.null_value", + "type": "CompoundType", + "label": "null_value", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L125" + }, + "signature": [ + "string | number | boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCoreFieldMapping.index", + "type": "CompoundType", + "label": "index", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L126" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", + "type": "CompoundType", + "label": "doc_values", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L127" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCoreFieldMapping.fields", + "type": "Object", + "label": "fields", + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L128" + }, + "signature": [ + "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L123" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsTypeMappingDefinition", + "type": "Interface", + "label": "SavedObjectsTypeMappingDefinition", + "description": [ + "\nDescribe a saved object type mapping.\n" + ], + "tags": [ + "example", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L40" + }, + "signature": [ + "false | \"strict\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeMappingDefinition.properties", + "type": "Object", + "label": "properties", + "description": [ + "The underlying properties of the type mapping" + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L42" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsMappingProperties", + "type": "Interface", + "label": "SavedObjectsMappingProperties", + "description": [ + "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.SavedObjectsMappingProperties.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L88" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L87" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsType", + "type": "Interface", + "label": "SavedObjectsType", + "description": [], + "tags": [ + "remarks", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsType.name", + "type": "string", + "label": "name", + "description": [ + "\nThe name of the type, which is also used as the internal id." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L237" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.hidden", + "type": "boolean", + "label": "hidden", + "description": [ + "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L244" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.namespaceType", + "type": "CompoundType", + "label": "namespaceType", + "description": [ + "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L248" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsNamespaceType", + "text": "SavedObjectsNamespaceType" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.indexPattern", + "type": "string", + "label": "indexPattern", + "description": [ + "\nIf defined, the type instances will be stored in the given index instead of the default one." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L252" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.convertToAliasScript", + "type": "string", + "label": "convertToAliasScript", + "description": [ + "\nIf defined, will be used to convert the type to an alias." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L256" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.mappings", + "type": "Object", + "label": "mappings", + "description": [ + "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L260" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeMappingDefinition", + "text": "SavedObjectsTypeMappingDefinition" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.migrations", + "type": "CompoundType", + "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": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L264" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + " | (() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", + "type": "string", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L313" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsType.management", + "type": "Object", + "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": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L317" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeManagementDefinition", + "text": "SavedObjectsTypeManagementDefinition" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L233" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsTypeManagementDefinition", + "type": "Interface", + "label": "SavedObjectsTypeManagementDefinition", + "description": [ + "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", + "type": "CompoundType", + "label": "importableAndExportable", + "description": [ + "\nIs the type importable or exportable. Defaults to `false`." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 329, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L329" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", + "type": "string", + "label": "defaultSearchField", + "description": [ + "\nThe default search field to use for this type. Defaults to `id`." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 333, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L333" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.icon", + "type": "string", + "label": "icon", + "description": [ + "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 338, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L338" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "type": "Function", + "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": 343, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L343" + }, + "signature": [ + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => string) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "type": "Function", + "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": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L348" + }, + "signature": [ + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => string) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", + "type": "Function", + "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": 357, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L357" + }, + "signature": [ + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => { path: string; uiCapabilitiesPath: string; }) | undefined" + ] + }, + { + "tags": [ + "remarks" + ], + "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", + "type": "Function", + "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": 368, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L368" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportTransform", + "text": "SavedObjectsExportTransform" + }, + " | undefined" + ] + }, + { + "tags": [ + "example", + "remarks", + "remarks" + ], + "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", + "type": "Function", + "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": 411, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L411" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportHook", + "text": "SavedObjectsImportHook" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 325, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L325" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectMigrationMap", + "type": "Interface", + "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": [ + "example", + "public" + ], + "children": [ + { + "id": "def-server.SavedObjectMigrationMap.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L88" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L87" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectExportBaseOptions", + "type": "Interface", + "label": "SavedObjectExportBaseOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectExportBaseOptions.request", + "type": "Object", + "label": "request", + "description": [ + "The http request initiating the export." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L15" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", + "type": "CompoundType", + "label": "includeReferencesDeep", + "description": [ + "flag to also include all related saved objects in the export stream." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L17" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", + "type": "CompoundType", + "label": "excludeExportDetails", + "description": [ + "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L19" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectExportBaseOptions.namespace", + "type": "string", + "label": "namespace", + "description": [ + "optional namespace to override the namespace used by the savedObjectsClient." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L21" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportByObjectOptions", + "type": "Interface", + "label": "SavedObjectsExportByObjectOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" + } + ], + "description": [ + "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExportByObjectOptions.objects", + "type": "Array", + "label": "objects", + "description": [ + "optional array of objects to export." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L45" + }, + "signature": [ + "{ id: string; type: string; }[]" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportByTypeOptions", + "type": "Interface", + "label": "SavedObjectsExportByTypeOptions", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" + } + ], + "description": [ + "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExportByTypeOptions.types", + "type": "Array", + "label": "types", + "description": [ + "array of saved object types." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L31" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", + "type": "Array", + "label": "hasReference", + "description": [ + "optional array of references to search object for." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L33" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExportByTypeOptions.search", + "type": "string", + "label": "search", + "description": [ + "optional query string to filter exported objects." + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L35" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportTransformContext", + "type": "Interface", + "label": "SavedObjectsExportTransformContext", + "description": [ + "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExportTransformContext.request", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L81" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L76" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportHookResult", + "type": "Interface", + "label": "SavedObjectsImportHookResult", + "description": [ + "\nResult from a {@link SavedObjectsImportHook | import hook}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportHookResult.warnings", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L231" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L227" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportSimpleWarning", + "type": "Interface", + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportSimpleWarning.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L187" + }, + "signature": [ + "\"simple\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSimpleWarning.message", + "type": "string", + "label": "message", + "description": [ + "The translated message to display to the user" + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L189" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L186" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportActionRequiredWarning", + "type": "Interface", + "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": [ + "remark", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 201, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L201" + }, + "signature": [ + "\"action_required\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportActionRequiredWarning.message", + "type": "string", + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to to address this warning." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L205" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L207" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L200" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBaseOptions", + "type": "Interface", + "label": "SavedObjectsBaseOptions", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBaseOptions.namespace", + "type": "string", + "label": "namespace", + "description": [ + "Specify the namespace for this operation" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L141" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L139" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindOptions", + "type": "Interface", + "label": "SavedObjectsFindOptions", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.sortOrder", + "type": "string", + "label": "sortOrder", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L82" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.SavedObjectsFindOptions.fields", + "type": "Array", + "label": "fields", + "description": [ + "\nAn array of fields to include in the results" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L88" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.search", + "type": "string", + "label": "search", + "description": [ + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.searchFields", + "type": "Array", + "label": "searchFields", + "description": [ + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.searchAfter", + "type": "Array", + "label": "searchAfter", + "description": [ + "\nUse the sort values from the previous page to retrieve the next page of results." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96" + }, + "signature": [ + "unknown[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", + "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": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", + "label": "hasReferenceOperator", + "description": [ + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111" + }, + "signature": [ + "\"AND\" | \"OR\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "label": "defaultSearchOperator", + "description": [ + "\nThe search operator to use with the provided filter. Defaults to `OR`" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116" + }, + "signature": [ + "\"AND\" | \"OR\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.filter", + "type": "Any", + "label": "filter", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L117" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.namespaces", + "type": "Array", + "label": "namespaces", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L118" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "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." + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126" + }, + "signature": [ + "Map | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.preference", + "type": "string", + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L128" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.pit", + "type": "Object", + "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": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L132" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindOptionsReference", + "type": "Interface", + "label": "SavedObjectsFindOptionsReference", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsFindOptionsReference.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L61" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptionsReference.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L62" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsPitParams", + "type": "Interface", + "label": "SavedObjectsPitParams", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsPitParams.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L69" + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsPitParams.keepAlive", + "type": "string", + "label": "keepAlive", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L70" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L68" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.SavedObjectsClientWrapperFactory", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L29" + }, + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperOptions", + "text": "SavedObjectsClientWrapperOptions" + }, + ") => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClientFactory", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L37" + }, + "signature": [ + "(__0: { request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; includedHiddenTypes?: string[] | undefined; }) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClientFactoryProvider", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L49" + }, + "signature": [ + "(repositoryFactory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepositoryFactory", + "text": "SavedObjectsRepositoryFactory" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactory", + "text": "SavedObjectsClientFactory" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClosePointInTimeOptions", + "type": "Type", + "label": "SavedObjectsClosePointInTimeOptions", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 375, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L375" + }, + "signature": [ + "SavedObjectsBaseOptions" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectSanitizedDoc", + "type": "Type", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L71" + }, + "signature": [ + "SavedObjectDoc & Referencable" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectUnsanitizedDoc", + "type": "Type", + "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" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L63" + }, + "signature": [ + "SavedObjectDoc & Partial" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectsRepository", + "type": "Type", + "label": "ISavedObjectsRepository", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link SavedObjectsRepository}\n" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L128" + }, + "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>; find: (options: SavedObjectsFindOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFieldMapping", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L99" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsComplexFieldMapping", + "text": "SavedObjectsComplexFieldMapping" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCoreFieldMapping", + "text": "SavedObjectsCoreFieldMapping" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectTypeRegistry", + "type": "Type", + "label": "ISavedObjectTypeRegistry", + "tags": [ + "public" + ], + "description": [ + "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L17" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsNamespaceType", + "type": "Type", + "label": "SavedObjectsNamespaceType", + "tags": [ + "public" + ], + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L226" + }, + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectMigrationFn", + "type": "Type", + "label": "SavedObjectMigrationFn", + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L45" + }, + "signature": [ + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectsExporter", + "type": "Type", + "label": "ISavedObjectsExporter", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L32" + }, + "signature": [ + "{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<", + "Readable", + ">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<", + "Readable", + ">; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportTransform", + "type": "Type", + "label": "SavedObjectsExportTransform", + "tags": [ + "example", + "example", + "remarks", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L155" + }, + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportTransformContext", + "text": "SavedObjectsExportTransformContext" + }, + ", objects: ", + "SavedObject", + "[]) => ", + "SavedObject", + "[] | Promise<", + "SavedObject", + "[]>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectsImporter", + "type": "Type", + "label": "ISavedObjectsImporter", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L24" + }, + "signature": [ + "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportHook", + "type": "Type", + "label": "SavedObjectsImportHook", + "tags": [ + "remark", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L246" + }, + "signature": [ + "(objects: ", + "SavedObject", + "[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportHookResult", + "text": "SavedObjectsImportHookResult" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportHookResult", + "text": "SavedObjectsImportHookResult" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportWarning", + "type": "Type", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L218" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSimpleWarning", + "text": "SavedObjectsImportSimpleWarning" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportActionRequiredWarning", + "text": "SavedObjectsImportActionRequiredWarning" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.MutatingOperationRefreshSetting", + "type": "Type", + "label": "MutatingOperationRefreshSetting", + "tags": [ + "public" + ], + "description": [ + "\nElasticsearch Refresh setting for mutating operation" + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 148, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L148" + }, + "signature": [ + "false | true | \"wait_for\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClientContract", + "type": "Type", + "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": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L212" + }, + "signature": [ + "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise>; find: (options: SavedObjectsFindOptions) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + } + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx new file mode 100644 index 0000000000000..d534853f7f29d --- /dev/null +++ b/api_docs/core_saved_objects.mdx @@ -0,0 +1,35 @@ +--- +id: kibCoreSavedObjectsPluginApi +slug: /kibana-dev-docs/core.savedObjectsPluginApi +title: core.savedObjects +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.savedObjects plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import coreSavedObjectsObj from './core_saved_objects.json'; + +## Client + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json new file mode 100644 index 0000000000000..0df54e577ede6 --- /dev/null +++ b/api_docs/dashboard.json @@ -0,0 +1,2610 @@ +{ + "id": "dashboard", + "client": { + "classes": [ + { + "id": "def-public.DashboardContainer", + "type": "Class", + "tags": [], + "label": "DashboardContainer", + "description": [], + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainer", + "text": "DashboardContainer" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Container", + "text": "Container" + }, + "<", + "InheritedChildInput", + ", ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.DashboardContainer.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L104" + }, + "signature": [ + "\"dashboard\"" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainer.switchViewMode", + "type": "Function", + "label": "switchViewMode", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L105" + }, + "signature": [ + "((newViewMode: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + }, + ") => void) | undefined" + ] + }, + { + "id": "def-public.DashboardContainer.getPanelCount", + "type": "Function", + "children": [], + "signature": [ + "() => number" + ], + "description": [], + "label": "getPanelCount", + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L107" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.DashboardContainer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initialInput", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L112" + } + }, + { + "type": "Object", + "label": "services", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerServices", + "text": "DashboardContainerServices" + } + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L113" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L114" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L111" + } + }, + { + "id": "def-public.DashboardContainer.createNewPanelState", + "type": "Function", + "label": "createNewPanelState", + "signature": [ + ">(factory: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + ", partial?: Partial) => ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.DashboardPanelState", + "text": "DashboardPanelState" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "factory", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L131" + } + }, + { + "type": "Object", + "label": "partial", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L132" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L127" + } + }, + { + "id": "def-public.DashboardContainer.showPlaceholderUntil", + "type": "Function", + "label": "showPlaceholderUntil", + "signature": [ + "(newStateComplete: Promise>>, placementMethod?: ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.PanelPlacementMethod", + "text": "PanelPlacementMethod" + }, + " | undefined, placementArgs?: TPlacementMethodArgs | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "newStateComplete", + "isRequired": true, + "signature": [ + "Promise>>" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L139" + } + }, + { + "type": "Function", + "label": "placementMethod", + "isRequired": false, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.PanelPlacementMethod", + "text": "PanelPlacementMethod" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L140" + } + }, + { + "type": "Uncategorized", + "label": "placementArgs", + "isRequired": false, + "signature": [ + "TPlacementMethodArgs | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L141" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L138" + } + }, + { + "id": "def-public.DashboardContainer.replacePanel", + "type": "Function", + "label": "replacePanel", + "signature": [ + "(previousPanelState: ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.DashboardPanelState", + "text": "DashboardPanelState" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ">, newPanelState: Partial<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "<{ id: string; }>>, generateNewId?: boolean | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "previousPanelState", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.DashboardPanelState", + "text": "DashboardPanelState" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L180" + } + }, + { + "type": "Object", + "label": "newPanelState", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "<{ id: string; }>>" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L181" + } + }, + { + "type": "CompoundType", + "label": "generateNewId", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L182" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L179" + } + }, + { + "id": "def-public.DashboardContainer.addOrUpdateEmbeddable", + "type": "Function", + "label": "addOrUpdateEmbeddable", + "signature": [ + "" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L230" + } + }, + { + "type": "string", + "label": "embeddableId", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L230" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L226" + } + }, + { + "id": "def-public.DashboardContainer.render", + "type": "Function", + "label": "render", + "signature": [ + "(dom: HTMLElement) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "dom", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L244" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L244" + } + }, + { + "id": "def-public.DashboardContainer.getInheritedInput", + "type": "Function", + "label": "getInheritedInput", + "signature": [ + "(id: string) => ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.InheritedChildInput", + "text": "InheritedChildInput" + } + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L255" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L255" + } + } + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L103" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DashboardContainerFactoryDefinition", + "type": "Class", + "tags": [], + "label": "DashboardContainerFactoryDefinition", + "description": [], + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerFactoryDefinition", + "text": "DashboardContainerFactoryDefinition" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + }, + "<", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ", ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainer", + "text": "DashboardContainer" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.DashboardContainerFactoryDefinition.isContainerType", + "type": "boolean", + "label": "isContainerType", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L32" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerFactoryDefinition.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L33" + }, + "signature": [ + "\"dashboard\"" + ] + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getStartServices", + "isRequired": true, + "signature": [ + "() => Promise<", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerServices", + "text": "DashboardContainerServices" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L35" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L35" + } + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.isEditable", + "type": "Function", + "children": [], + "signature": [ + "() => Promise" + ], + "description": [], + "label": "isEditable", + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L37" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.getDisplayName", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getDisplayName", + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L42" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.getDefaultInput", + "type": "Function", + "label": "getDefaultInput", + "signature": [ + "() => Partial<", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + }, + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L48" + } + }, + { + "id": "def-public.DashboardContainerFactoryDefinition.create", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "initialInput", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L59" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L60" + } + } + ], + "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" + } + ], + "description": [], + "label": "create", + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L58" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L29" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.createDashboardEditUrl", + "type": "Function", + "label": "createDashboardEditUrl", + "signature": [ + "(id: string | undefined, editMode: boolean | undefined) => string" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "editMode", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.createDashboardUrlGenerator", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L92" + } + } + ], + "signature": [ + "(getStartServices: () => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectLoader", + "text": "SavedObjectLoader" + }, + "; }>) => ", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorsDefinition", + "text": "UrlGeneratorsDefinition" + }, + "<\"DASHBOARD_APP_URL_GENERATOR\">" + ], + "description": [], + "label": "createDashboardUrlGenerator", + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L91" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.DashboardContainerInput", + "type": "Interface", + "label": "DashboardContainerInput", + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardContainerInput", + "text": "DashboardContainerInput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardContainerInput.dashboardCapabilities", + "type": "Object", + "label": "dashboardCapabilities", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L43" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardCapabilities", + "text": "DashboardCapabilities" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.refreshConfig", + "type": "Object", + "label": "refreshConfig", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L44" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.isEmbeddedExternally", + "type": "CompoundType", + "label": "isEmbeddedExternally", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L45" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.isFullScreenMode", + "type": "boolean", + "label": "isFullScreenMode", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L46" + } + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.expandedPanelId", + "type": "string", + "label": "expandedPanelId", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L47" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L48" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L49" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.useMargins", + "type": "boolean", + "label": "useMargins", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L50" + } + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.syncColors", + "type": "CompoundType", + "label": "syncColors", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L51" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.viewMode", + "type": "Enum", + "label": "viewMode", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L52" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L53" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L54" + } + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L55" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardContainerInput.panels", + "type": "Object", + "label": "panels", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L56" + }, + "signature": [ + "{ [panelId: string]: ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.DashboardPanelState", + "text": "DashboardPanelState" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " & { [k: string]: unknown; }>; }" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DashboardFeatureFlagConfig", + "type": "Interface", + "label": "DashboardFeatureFlagConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardFeatureFlagConfig.allowByValueEmbeddables", + "type": "boolean", + "label": "allowByValueEmbeddables", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L89" + } + } + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DashboardUrlGeneratorState", + "type": "Interface", + "label": "DashboardUrlGeneratorState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.dashboardId", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L34" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.timeRange", + "type": "Object", + "label": "timeRange", + "description": [ + "\nOptionally set the time range in the time picker." + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L38" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.refreshInterval", + "type": "Object", + "label": "refreshInterval", + "description": [ + "\nOptionally set the refresh interval." + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L43" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.filters", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L49" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.query", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L54" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.useHash", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L59" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.preserveSavedFilters", + "type": "CompoundType", + "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" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L67" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.viewMode", + "type": "CompoundType", + "label": "viewMode", + "description": [ + "\nView mode of the dashboard." + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L72" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.searchSessionId", + "type": "string", + "label": "searchSessionId", + "description": [ + "\nSearch search session ID to restore.\n(Background search)" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L78" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.panels", + "type": "Array", + "label": "panels", + "description": [ + "\nList of dashboard panels" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L83" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel730ToLatest", + "text": "SavedDashboardPanel730ToLatest" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.savedQuery", + "type": "string", + "label": "savedQuery", + "description": [ + "\nSaved query ID" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L88" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DashboardSavedObject", + "type": "Interface", + "label": "DashboardSavedObject", + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardSavedObject", + "text": "DashboardSavedObject" + }, + " extends ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObject", + "text": "SavedObject" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardSavedObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L19" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.timeRestore", + "type": "boolean", + "label": "timeRestore", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.timeTo", + "type": "string", + "label": "timeTo", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L21" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.timeFrom", + "type": "string", + "label": "timeFrom", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L22" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L23" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.panelsJSON", + "type": "string", + "label": "panelsJSON", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.optionsJSON", + "type": "string", + "label": "optionsJSON", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L25" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.uiStateJSON", + "type": "string", + "label": "uiStateJSON", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.lastSavedTitle", + "type": "string", + "label": "lastSavedTitle", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.refreshInterval", + "type": "Object", + "label": "refreshInterval", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L29" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.searchSource", + "type": "Object", + "label": "searchSource", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L30" + }, + "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\">" + ] + }, + { + "id": "def-public.DashboardSavedObject.getQuery", + "type": "Function", + "label": "getQuery", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L31" + } + }, + { + "id": "def-public.DashboardSavedObject.getFilters", + "type": "Function", + "label": "getFilters", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L32" + } + }, + { + "tags": [], + "id": "def-public.DashboardSavedObject.getFullEditPath", + "type": "Function", + "label": "getFullEditPath", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L33" + }, + "signature": [ + "(editMode?: boolean | undefined) => string" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L18" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.DASHBOARD_CONTAINER_TYPE", + "type": "string", + "label": "DASHBOARD_CONTAINER_TYPE", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_constants.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_constants.ts#L13" + }, + "signature": [ + "\"dashboard\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.DashboardUrlGenerator", + "type": "Type", + "label": "DashboardUrlGenerator", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L86" + }, + "signature": [ + "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.DASHBOARD_APP_URL_GENERATOR", + "type": "string", + "label": "DASHBOARD_APP_URL_GENERATOR", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L27" + }, + "signature": [ + "\"DASHBOARD_APP_URL_GENERATOR\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SavedDashboardPanel", + "type": "Type", + "label": "SavedDashboardPanel", + "tags": [], + "description": [ + "\nThis should always represent the latest dashboard panel shape, after all possible migrations." + ], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L33" + }, + "signature": [ + "Pick & { readonly id?: string | undefined; readonly type: string; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.DashboardConstants", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardConstants.LANDING_PAGE_PATH", + "type": "string", + "label": "LANDING_PAGE_PATH", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.CREATE_NEW_DASHBOARD_URL", + "type": "string", + "label": "CREATE_NEW_DASHBOARD_URL", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.VIEW_DASHBOARD_URL", + "type": "string", + "label": "VIEW_DASHBOARD_URL", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.ADD_EMBEDDABLE_ID", + "type": "string", + "label": "ADD_EMBEDDABLE_ID", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.ADD_EMBEDDABLE_TYPE", + "type": "string", + "label": "ADD_EMBEDDABLE_TYPE", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.DASHBOARDS_ID", + "type": "string", + "label": "DASHBOARDS_ID", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.DASHBOARD_ID", + "type": "string", + "label": "DASHBOARD_ID", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.DashboardConstants.SEARCH_SESSION_ID", + "type": "string", + "label": "SEARCH_SESSION_ID", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L19" + } + } + ], + "description": [], + "label": "DashboardConstants", + "source": { + "path": "src/plugins/dashboard/public/dashboard_constants.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L11" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-public.DashboardSetup", + "type": "Type", + "label": "DashboardSetup", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L118" + }, + "signature": [ + "void" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.DashboardStart", + "type": "Interface", + "label": "DashboardStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DashboardStart.getSavedDashboardLoader", + "type": "Function", + "label": "getSavedDashboardLoader", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L121" + }, + "signature": [ + "() => ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectLoader", + "text": "SavedObjectLoader" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardStart.dashboardUrlGenerator", + "type": "Object", + "label": "dashboardUrlGenerator", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L122" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardUrlGenerator", + "text": "DashboardUrlGenerator" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardStart.dashboardFeatureFlagConfig", + "type": "Object", + "label": "dashboardFeatureFlagConfig", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L123" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardFeatureFlagConfig", + "text": "DashboardFeatureFlagConfig" + } + ] + }, + { + "tags": [], + "id": "def-public.DashboardStart.DashboardContainerByValueRenderer", + "type": "Function", + "label": "DashboardContainerByValueRenderer", + "description": [], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L124" + }, + "signature": [ + "React.FC" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L120" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.migratePanelsTo730", + "type": "Function", + "label": "migratePanelsTo730", + "signature": [ + "(panels: (", + "RawSavedDashboardPanelTo60", + " | ", + "RawSavedDashboardPanel610", + " | ", + "RawSavedDashboardPanel620", + " | Pick<", + "RawSavedDashboardPanel620", + ", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanelTo60", + "text": "SavedDashboardPanelTo60" + } + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "panels", + "isRequired": true, + "signature": [ + "(", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanelTo60", + "text": "RawSavedDashboardPanelTo60" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel610", + "text": "RawSavedDashboardPanel610" + }, + " | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel620", + "text": "RawSavedDashboardPanel620" + }, + " | Pick<", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.RawSavedDashboardPanel620", + "text": "RawSavedDashboardPanel620" + }, + ", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanelTo60", + "text": "SavedDashboardPanelTo60" + } + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L262" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 274, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L274" + } + }, + { + "type": "boolean", + "label": "useMargins", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 275, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L275" + } + }, + { + "id": "def-common.migratePanelsTo730.uiState", + "type": "Object", + "label": "uiState", + "tags": [], + "description": [], + "children": [ + { + "id": "def-common.migratePanelsTo730.uiState.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 276, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L276" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 276, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L276" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dashboard/common/migrate_to_730_panels.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L261" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.GridData", + "type": "Interface", + "label": "GridData", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GridData.w", + "type": "number", + "label": "w", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.GridData.h", + "type": "number", + "label": "h", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.GridData.x", + "type": "number", + "label": "x", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.GridData.y", + "type": "number", + "label": "y", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.GridData.i", + "type": "string", + "label": "i", + "description": [], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L14" + } + } + ], + "source": { + "path": "src/plugins/dashboard/common/embeddable/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L9" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-common.RawSavedDashboardPanel730ToLatest", + "type": "Type", + "label": "RawSavedDashboardPanel730ToLatest", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/bwc/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L70" + }, + "signature": [ + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DashboardDoc730ToLatest", + "type": "Type", + "label": "DashboardDoc730ToLatest", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/bwc/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L53" + }, + "signature": [ + "Doc" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DashboardDoc700To720", + "type": "Type", + "label": "DashboardDoc700To720", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/bwc/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L55" + }, + "signature": [ + "Doc" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DashboardDocPre700", + "type": "Type", + "label": "DashboardDocPre700", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/bwc/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L57" + }, + "signature": [ + "DocPre700" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanelTo60", + "type": "Type", + "label": "SavedDashboardPanelTo60", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L67" + }, + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanel610", + "type": "Type", + "label": "SavedDashboardPanel610", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L59" + }, + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanel620", + "type": "Type", + "label": "SavedDashboardPanel620", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L51" + }, + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanel630", + "type": "Type", + "label": "SavedDashboardPanel630", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L43" + }, + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanel640To720", + "type": "Type", + "label": "SavedDashboardPanel640To720", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L35" + }, + "signature": [ + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanel730ToLatest", + "type": "Type", + "label": "SavedDashboardPanel730ToLatest", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L76" + }, + "signature": [ + "Pick & { readonly id?: string | undefined; readonly type: string; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx new file mode 100644 index 0000000000000..3c592a41e2f86 --- /dev/null +++ b/api_docs/dashboard.mdx @@ -0,0 +1,47 @@ +--- +id: kibDashboardPluginApi +slug: /kibana-dev-docs/dashboardPluginApi +title: dashboard +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboard plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dashboardObj from './dashboard.json'; + +## Client + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json new file mode 100644 index 0000000000000..ee634d0c69048 --- /dev/null +++ b/api_docs/dashboard_enhanced.json @@ -0,0 +1,1086 @@ +{ + "id": "dashboardEnhanced", + "client": { + "classes": [ + { + "id": "def-public.AbstractDashboardDrilldown", + "type": "Class", + "tags": [], + "label": "AbstractDashboardDrilldown", + "description": [], + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "public", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-public.AbstractDashboardDrilldown", + "text": "AbstractDashboardDrilldown" + }, + " implements ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.DrilldownDefinition", + "text": "DrilldownDefinition" + }, + "<", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + }, + ", Context, ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.BaseActionFactoryContext", + "text": "BaseActionFactoryContext" + }, + ">" + ], + "children": [ + { + "id": "def-public.AbstractDashboardDrilldown.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "public", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-public.Params", + "text": "Params" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36" + } + }, + { + "tags": [], + "id": "def-public.AbstractDashboardDrilldown.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L38" + } + }, + { + "tags": [], + "id": "def-public.AbstractDashboardDrilldown.supportedTriggers", + "type": "Function", + "label": "supportedTriggers", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L40" + }, + "signature": [ + "() => string[]" + ] + }, + { + "id": "def-public.AbstractDashboardDrilldown.getURL", + "type": "Function", + "label": "getURL", + "signature": [ + "(config: ", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + }, + ", context: Context) => Promise<", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.KibanaURL", + "text": "KibanaURL" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42" + } + }, + { + "type": "Uncategorized", + "label": "context", + "isRequired": true, + "signature": [ + "Context" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42" + } + }, + { + "tags": [], + "id": "def-public.AbstractDashboardDrilldown.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L44" + }, + "signature": [ + "100" + ] + }, + { + "id": "def-public.AbstractDashboardDrilldown.getDisplayName", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getDisplayName", + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L46" + }, + "tags": [], + "returnComment": [] + }, + { + "tags": [], + "id": "def-public.AbstractDashboardDrilldown.euiIcon", + "type": "string", + "label": "euiIcon", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L48" + }, + "signature": [ + "\"dashboardApp\"" + ] + }, + { + "tags": [], + "id": "def-public.AbstractDashboardDrilldown.CollectConfig", + "type": "Function", + "label": "CollectConfig", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L54" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.CollectConfigProps", + "text": "CollectConfigProps" + }, + "<", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + }, + ", ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.BaseActionFactoryContext", + "text": "BaseActionFactoryContext" + }, + ">>" + ] + }, + { + "id": "def-public.AbstractDashboardDrilldown.createConfig", + "type": "Function", + "children": [], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L56" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AbstractDashboardDrilldown.isConfigValid", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62" + } + } + ], + "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" + } + ], + "description": [], + "label": "isConfigValid", + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AbstractDashboardDrilldown.getHref", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67" + } + }, + { + "type": "Uncategorized", + "label": "context", + "isRequired": true, + "signature": [ + "Context" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67" + } + } + ], + "signature": [ + "(config: ", + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + }, + ", 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AbstractDashboardDrilldown.execute", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "dashboardEnhanced", + "scope": "common", + "docId": "kibDashboardEnhancedPluginApi", + "section": "def-common.DrilldownConfig", + "text": "DrilldownConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72" + } + }, + { + "type": "Uncategorized", + "label": "context", + "isRequired": true, + "signature": [ + "Context" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AbstractDashboardDrilldown.urlGenerator", + "type": "Object", + "label": "urlGenerator", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L77" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardUrlGenerator", + "text": "DashboardUrlGenerator" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L34" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.SetupDependencies", + "type": "Interface", + "label": "SetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SetupDependencies.uiActionsEnhanced", + "type": "Object", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L17" + }, + "signature": [ + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.SetupContract", + "text": "SetupContract" + } + ] + }, + { + "tags": [], + "id": "def-public.SetupDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L18" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableSetup", + "text": "EmbeddableSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.SetupDependencies.share", + "type": "CompoundType", + "label": "share", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L19" + }, + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.SharePluginSetup", + "text": "SharePluginSetup" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.StartDependencies", + "type": "Interface", + "label": "StartDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.StartDependencies.uiActionsEnhanced", + "type": "Object", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L23" + }, + "signature": [ + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.StartContract", + "text": "StartContract" + } + ] + }, + { + "tags": [], + "id": "def-public.StartDependencies.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L24" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } + ] + }, + { + "tags": [], + "id": "def-public.StartDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L25" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStart", + "text": "EmbeddableStart" + } + ] + }, + { + "tags": [], + "id": "def-public.StartDependencies.share", + "type": "CompoundType", + "label": "share", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L26" + }, + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.SharePluginStart", + "text": "SharePluginStart" + } + ] + }, + { + "tags": [], + "id": "def-public.StartDependencies.dashboard", + "type": "Object", + "label": "dashboard", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L27" + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardStart", + "text": "DashboardStart" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Params", + "type": "Interface", + "label": "Params", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Params.start", + "type": "Function", + "label": "start", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L27" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.StartServicesGetter", + "text": "StartServicesGetter" + }, + "<{ uiActionsEnhanced: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.StartContract", + "text": "StartContract" + }, + "; data: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + }, + "; dashboard: ", + { + "pluginId": "dashboard", + "scope": "public", + "docId": "kibDashboardPluginApi", + "section": "def-public.DashboardStart", + "text": "DashboardStart" + }, + "; }, unknown, ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L26" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.Config", + "type": "Type", + "label": "Config", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts#L11" + }, + "signature": [ + "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.SetupContract", + "type": "Interface", + "label": "SetupContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L31" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.StartContract", + "type": "Interface", + "label": "StartContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L34" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.SetupDependencies", + "type": "Interface", + "label": "SetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SetupDependencies.uiActionsEnhanced", + "type": "Object", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L13" + }, + "signature": [ + { + "pluginId": "uiActionsEnhanced", + "scope": "server", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-server.SetupContract", + "text": "SetupContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-server.StartDependencies", + "type": "Interface", + "label": "StartDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.StartDependencies.uiActionsEnhanced", + "type": "Uncategorized", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L17" + }, + "signature": [ + "void" + ] + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L16" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.SetupContract", + "type": "Interface", + "label": "SetupContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L21" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.StartContract", + "type": "Interface", + "label": "StartContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L24" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.createExtract", + "type": "Function", + "children": [ + { + "id": "def-common.createExtract.{\n- drilldownId,\n}", + "type": "Object", + "label": "{\n drilldownId,\n}", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.createExtract.{\n- drilldownId,\n}.drilldownId", + "type": "string", + "label": "drilldownId", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L49" + } + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L48" + } + } + ], + "signature": [ + "({ drilldownId, }: { drilldownId: string; }) => (state: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "common", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-common.SerializedEvent", + "text": "SerializedEvent" + }, + ") => { state: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "common", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-common.SerializedEvent", + "text": "SerializedEvent" + }, + "; references: ", + "SavedObjectReference", + "[]; }" + ], + "description": [], + "label": "createExtract", + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L46" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createInject", + "type": "Function", + "children": [ + { + "id": "def-common.createInject.{\n- drilldownId,\n}", + "type": "Object", + "label": "{\n drilldownId,\n}", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.createInject.{\n- drilldownId,\n}.drilldownId", + "type": "string", + "label": "drilldownId", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L34" + } + } + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L33" + } + } + ], + "signature": [ + "({ drilldownId, }: { drilldownId: string; }) => (state: ", + { + "pluginId": "uiActionsEnhanced", + "scope": "common", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-common.SerializedEvent", + "text": "SerializedEvent" + }, + ", references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "uiActionsEnhanced", + "scope": "common", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-common.SerializedEvent", + "text": "SerializedEvent" + } + ], + "description": [], + "label": "createInject", + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.EMBEDDABLE_TO_DASHBOARD_DRILLDOWN", + "type": "string", + "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" + ], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts#L15" + }, + "signature": [ + "\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DrilldownConfig", + "type": "Type", + "label": "DrilldownConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts#L9" + }, + "signature": [ + "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx new file mode 100644 index 0000000000000..1ef8820befc41 --- /dev/null +++ b/api_docs/dashboard_enhanced.mdx @@ -0,0 +1,49 @@ +--- +id: kibDashboardEnhancedPluginApi +slug: /kibana-dev-docs/dashboardEnhancedPluginApi +title: dashboardEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboardEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dashboardEnhancedObj from './dashboard_enhanced.json'; + +## Client + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Interfaces + + +## Common + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/dashboard_mode.json b/api_docs/dashboard_mode.json new file mode 100644 index 0000000000000..d021b31e9596b --- /dev/null +++ b/api_docs/dashboard_mode.json @@ -0,0 +1,252 @@ +{ + "id": "dashboardMode", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.DashboardModeServerPlugin", + "type": "Class", + "tags": [], + "label": "DashboardModeServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "dashboardMode", + "scope": "server", + "docId": "kibDashboardModePluginApi", + "section": "def-server.DashboardModeServerPlugin", + "text": "DashboardModeServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "" + ], + "children": [ + { + "id": "def-server.DashboardModeServerPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30" + } + }, + { + "id": "def-server.DashboardModeServerPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", { security }: DashboardModeServerSetupDependencies) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34" + } + }, + { + "type": "Object", + "label": "{ security }", + "isRequired": true, + "signature": [ + "DashboardModeServerSetupDependencies" + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34" + } + }, + { + "id": "def-server.DashboardModeServerPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60" + } + }, + { + "id": "def-server.DashboardModeServerPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L62" + } + } + ], + "source": { + "path": "x-pack/plugins/dashboard_mode/server/plugin.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L26" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "id": "def-common.UI_SETTINGS", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES", + "type": "string", + "label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES", + "description": [], + "source": { + "path": "x-pack/plugins/dashboard_mode/common/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L9" + } + } + ], + "description": [], + "label": "UI_SETTINGS", + "source": { + "path": "x-pack/plugins/dashboard_mode/common/constants.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L8" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/dashboard_mode.mdx b/api_docs/dashboard_mode.mdx new file mode 100644 index 0000000000000..2108754adbd5d --- /dev/null +++ b/api_docs/dashboard_mode.mdx @@ -0,0 +1,23 @@ +--- +id: kibDashboardModePluginApi +slug: /kibana-dev-docs/dashboardModePluginApi +title: dashboardMode +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboardMode plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardMode'] +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 dashboardModeObj from './dashboard_mode.json'; + +## Server + +### Classes + + +## Common + +### Objects + + diff --git a/api_docs/data.json b/api_docs/data.json new file mode 100644 index 0000000000000..5d67995056336 --- /dev/null +++ b/api_docs/data.json @@ -0,0 +1,29115 @@ +{ + "id": "data", + "client": { + "classes": [ + { + "id": "def-public.FieldFormat", + "type": "Class", + "tags": [], + "label": "FieldFormat", + "description": [], + "children": [ + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-public.FieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L32" + } + }, + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-public.FieldFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L38" + } + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-public.FieldFormat.fieldType", + "type": "CompoundType", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L44" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-public.FieldFormat.convertObject", + "type": "Object", + "label": "convertObject", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-public.FieldFormat.htmlConvert", + "type": "Function", + "label": "htmlConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L60" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeConvert", + "text": "HtmlContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-public.FieldFormat.textConvert", + "type": "Function", + "label": "textConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L68" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TextContextTypeConvert", + "text": "TextContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-public.FieldFormat.type", + "type": "Any", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L74" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.FieldFormat.allowsNumericalAggregations", + "type": "CompoundType", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L75" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FieldFormat._params", + "type": "Any", + "label": "_params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L77" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.FieldFormat.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L78" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | undefined" + ] + }, + { + "id": "def-public.FieldFormat.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "_params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IFieldFormatMetaParams", + "text": "IFieldFormatMetaParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + }, + { + "type": "Function", + "label": "getConfig", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + }, + { + "id": "def-public.FieldFormat.convert", + "type": "Function", + "label": "convert", + "signature": [ + "(value: any, contentType?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + }, + ", options?: Record | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined) => string" + ], + "description": [ + "\nConvert a raw value to a formatted string" + ], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L99" + } + }, + { + "type": "CompoundType", + "label": "contentType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L100" + } + }, + { + "type": "CompoundType", + "label": "options", + "isRequired": false, + "signature": [ + "Record | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L101" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L98" + } + }, + { + "id": "def-public.FieldFormat.getConverterFor", + "type": "Function", + "label": "getConverterFor", + "signature": [ + "(contentType?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" + } + ], + "description": [ + "\nGet a convert function that is bound to a specific contentType" + ], + "children": [ + { + "type": "CompoundType", + "label": "contentType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L119" + } + } + ], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- a bound converter function" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L118" + } + }, + { + "id": "def-public.FieldFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => Record" + ], + "description": [ + "\nGet parameter defaults" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- parameter defaults" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L133" + } + }, + { + "id": "def-public.FieldFormat.param", + "type": "Function", + "label": "param", + "signature": [ + "(name: string) => any" + ], + "description": [ + "\nGet the value of a param. This value may be a default value.\n" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- the param name to fetch" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144" + } + } + ], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144" + } + }, + { + "id": "def-public.FieldFormat.params", + "type": "Function", + "label": "params", + "signature": [ + "() => Record" + ], + "description": [ + "\nGet all of the params in a single object" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L161" + } + }, + { + "id": "def-public.FieldFormat.toJSON", + "type": "Function", + "label": "toJSON", + "signature": [ + "() => { id: any; params: any; }" + ], + "description": [ + "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L172" + } + }, + { + "id": "def-public.FieldFormat.from", + "type": "Function", + "label": "from", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".from" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "convertFn", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193" + } + }, + { + "id": "def-public.FieldFormat.setupContentType", + "type": "Function", + "label": "setupContentType", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L197" + } + }, + { + "id": "def-public.FieldFormat.isInstanceOfFieldFormat", + "type": "Function", + "label": "isInstanceOfFieldFormat", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".isInstanceOfFieldFormat" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "fieldFormat", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternsService.ensureDefaultIndexPattern", + "type": "Function", + "label": "ensureDefaultIndexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-public.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "isRequired": true, + "signature": [ + "IndexPatternsServiceDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + }, + { + "id": "def-public.IndexPatternsService.getIds", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.getTitles", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.find", + "type": "Function", + "children": [ + { + "type": "string", + "label": "search", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + }, + { + "type": "number", + "label": "size", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] + }, + { + "id": "def-public.IndexPatternsService.getIdsWithTitle", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.clearCache", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.getCache", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" + }, + ">[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>" + ], + "description": [ + "\nGet default index pattern" + ], + "label": "getDefault", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.setDefault", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + }, + { + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.getFieldsForWildcard", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + } + } + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "description": [ + "\nGet field list by providing { pattern }" + ], + "label": "getFieldsForWildcard", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-public.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237" + } + } + ], + "signature": [ + "(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", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], + "label": "getFieldsForIndexPattern", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-public.IndexPatternsService.refreshFields", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + } + } + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise" + ], + "description": [ + "\nRefresh field list for a given index pattern" + ], + "label": "refreshFields", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "fields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + }, + { + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" + ], + "description": [ + "\nConverts field array to map" + ], + "label": "fieldArrayToMap", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-public.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObject", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + } + } + ], + "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] + }, + { + "id": "def-public.IndexPatternsService.get", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + } + } + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "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": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPatternsService.create", + "type": "Function", + "label": "create", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern instance" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + } + ], + "tags": [], + "returnComment": [ + "IndexPattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "id": "def-public.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern and save it right away" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Whether to skip field refresh step." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "id": "def-public.IndexPatternsService.createSavedObject", + "type": "Function", + "label": "createSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nSave a new index pattern" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "id": "def-public.IndexPatternsService.updateSavedObject", + "type": "Function", + "label": "updateSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547" + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548" + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" + } + }, + { + "id": "def-public.IndexPatternsService.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "description": [ + "\nDeletes an index pattern from .kibana index" + ], + "children": [ + { + "type": "string", + "label": "indexPatternId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPattern", + "type": "Class", + "tags": [], + "label": "IndexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " implements ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.IndexPattern.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46" + } + }, + { + "tags": [], + "id": "def-public.IndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.typeMeta", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.fields", + "type": "CompoundType", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => Record; }" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.IndexPattern.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.type", + "type": "string", + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.formatHit", + "type": "Function", + "label": "formatHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63" + }, + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.formatField", + "type": "Function", + "label": "formatField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67" + }, + "signature": [ + "FormatFieldFn" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.flattenHit", + "type": "Function", + "label": "flattenHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68" + }, + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.version", + "type": "string", + "label": "version", + "description": [ + "\nSavedObject version" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.sourceFilters", + "type": "Array", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPattern.allowNoIndex", + "type": "boolean", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84" + } + }, + { + "id": "def-public.IndexPattern.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", + "isRequired": true, + "signature": [ + "IndexPatternDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + }, + { + "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; }" + ], + "description": [ + "\nGet last saved saved object fields" + ], + "label": "getOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPattern.resetOriginalSavedObjectBody", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [ + "\nReset last saved saved object fields. used after saving" + ], + "label": "resetOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPattern.getFieldAttrs", + "type": "Function", + "children": [], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "description": [], + "label": "getFieldAttrs", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPattern.getComputedFields", + "type": "Function", + "label": "getComputedFields", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162" + } + }, + { + "id": "def-public.IndexPattern.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208" + } + }, + { + "id": "def-public.IndexPattern.getSourceFiltering", + "type": "Function", + "label": "getSourceFiltering", + "signature": [ + "() => { excludes: any[]; }" + ], + "description": [ + "\nGet the source filtering configuration for that index." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230" + } + }, + { + "id": "def-public.IndexPattern.addScriptedField", + "type": "Function", + "label": "addScriptedField", + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "description": [ + "\nAdd scripted field to field list\n" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "script", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "script code" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "fieldType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "id": "def-public.IndexPattern.removeScriptedField", + "type": "Function", + "label": "removeScriptedField", + "signature": [ + "(fieldName: string) => void" + ], + "description": [ + "\nRemove scripted field from field list" + ], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + }, + { + "id": "def-public.IndexPattern.getNonScriptedFields", + "type": "Function", + "label": "getNonScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277" + } + }, + { + "id": "def-public.IndexPattern.getScriptedFields", + "type": "Function", + "label": "getScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281" + } + }, + { + "id": "def-public.IndexPattern.isTimeBased", + "type": "Function", + "label": "isTimeBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285" + } + }, + { + "id": "def-public.IndexPattern.isTimeNanosBased", + "type": "Function", + "label": "isTimeNanosBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289" + } + }, + { + "id": "def-public.IndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294" + } + }, + { + "id": "def-public.IndexPattern.getFieldByName", + "type": "Function", + "label": "getFieldByName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + }, + { + "id": "def-public.IndexPattern.getAggregationRestrictions", + "type": "Function", + "label": "getAggregationRestrictions", + "signature": [ + "() => Record> | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304" + } + }, + { + "id": "def-public.IndexPattern.getAsSavedObjectBody", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311" + } + }, + { + "id": "def-public.IndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "description": [ + "\nProvide a field, get its formatter" + ], + "children": [ + { + "type": "CompoundType", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 340, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339" + } + }, + { + "id": "def-public.IndexPattern.addRuntimeField", + "type": "Function", + "label": "addRuntimeField", + "signature": [ + "(name: string, runtimeField: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => void" + ], + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "type": "Object", + "label": "runtimeField", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "description": [ + "Runtime field definition" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "id": "def-public.IndexPattern.removeRuntimeField", + "type": "Function", + "label": "removeRuntimeField", + "signature": [ + "(name: string) => void" + ], + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + }, + { + "id": "def-public.IndexPattern.getFormatterForFieldNoDefault", + "type": "Function", + "label": "getFormatterForFieldNoDefault", + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], + "children": [ + { + "type": "string", + "label": "fieldname", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + }, + { + "id": "def-public.IndexPattern.setFieldAttrs", + "type": "Function", + "label": "setFieldAttrs", + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 412, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412" + } + }, + { + "type": "Uncategorized", + "label": "attrName", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 413, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413" + } + }, + { + "type": "Uncategorized", + "label": "value", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411" + } + }, + { + "id": "def-public.IndexPattern.setFieldCustomLabel", + "type": "Function", + "label": "setFieldCustomLabel", + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "type": "CompoundType", + "label": "customLabel", + "isRequired": false, + "signature": [ + "string | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "id": "def-public.IndexPattern.setFieldCount", + "type": "Function", + "label": "setFieldCount", + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "type": "CompoundType", + "label": "count", + "isRequired": false, + "signature": [ + "number | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "id": "def-public.IndexPattern.setFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + }, + { + "type": "Object", + "label": "format", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPattern.deleteFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + } + } + ], + "signature": [ + "(fieldName: string) => void" + ], + "description": [], + "label": "deleteFieldFormat", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternField", + "type": "Class", + "tags": [], + "label": "IndexPatternField", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " implements ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternField.spec", + "type": "Object", + "label": "spec", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + }, + { + "id": "def-public.IndexPatternField.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21" + } + }, + { + "id": "def-public.IndexPatternField.count", + "type": "number", + "label": "count", + "tags": [], + "description": [ + "\nCount is used for field popularity" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L31" + } + }, + { + "id": "def-public.IndexPatternField.count", + "type": "number", + "label": "count", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L35" + } + }, + { + "id": "def-public.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L39" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L43" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.script", + "type": "string", + "label": "script", + "tags": [], + "description": [ + "\nScript field code" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L50" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.script", + "type": "string", + "label": "script", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.lang", + "type": "string", + "label": "lang", + "tags": [], + "description": [ + "\nScript field language" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.lang", + "type": "string", + "label": "lang", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L65" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L69" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "tags": [], + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L80" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L84" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L89" + } + }, + { + "id": "def-public.IndexPatternField.displayName", + "type": "string", + "label": "displayName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L93" + } + }, + { + "id": "def-public.IndexPatternField.type", + "type": "string", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L101" + } + }, + { + "id": "def-public.IndexPatternField.esTypes", + "type": "Array", + "label": "esTypes", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L107" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.scripted", + "type": "boolean", + "label": "scripted", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L111" + } + }, + { + "id": "def-public.IndexPatternField.searchable", + "type": "boolean", + "label": "searchable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L115" + } + }, + { + "id": "def-public.IndexPatternField.aggregatable", + "type": "boolean", + "label": "aggregatable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L119" + } + }, + { + "id": "def-public.IndexPatternField.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L123" + } + }, + { + "id": "def-public.IndexPatternField.subType", + "type": "Object", + "label": "subType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L127" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.isMapped", + "type": "CompoundType", + "label": "isMapped", + "tags": [], + "description": [ + "\nIs the field part of the index mapping?" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L134" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.sortable", + "type": "boolean", + "label": "sortable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L139" + } + }, + { + "id": "def-public.IndexPatternField.filterable", + "type": "boolean", + "label": "filterable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L146" + } + }, + { + "id": "def-public.IndexPatternField.visualizable", + "type": "boolean", + "label": "visualizable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L154" + } + }, + { + "id": "def-public.IndexPatternField.deleteCount", + "type": "Function", + "label": "deleteCount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L159" + } + }, + { + "id": "def-public.IndexPatternField.toJSON", + "type": "Function", + "label": "toJSON", + "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: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined; customLabel: string | undefined; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L163" + } + }, + { + "id": "def-public.IndexPatternField.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "children": [ + { + "id": "def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", + "type": "Object", + "label": "{\n getFormatterForField,\n }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L184" + }, + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L183" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L181" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DuplicateIndexPatternError", + "type": "Class", + "tags": [], + "label": "DuplicateIndexPatternError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.DuplicateIndexPatternError", + "text": "DuplicateIndexPatternError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-public.DuplicateIndexPatternError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggParamType", + "type": "Class", + "tags": [], + "label": "AggParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.AggParamType.makeAgg", + "type": "Function", + "label": "makeAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15" + }, + "signature": [ + "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" + ] + }, + { + "tags": [], + "id": "def-public.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16" + }, + "signature": [ + "string[]" + ] + }, + { + "id": "def-public.AggParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OptionedParamType", + "type": "Class", + "tags": [], + "label": "OptionedParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedParamType", + "text": "OptionedParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-public.OptionedParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" + }, + "[]" + ] + }, + { + "id": "def-public.OptionedParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggConfigs", + "type": "Class", + "tags": [], + "label": "AggConfigs", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.AggConfigs.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L58" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ] + }, + { + "tags": [], + "id": "def-public.AggConfigs.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L59" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AggConfigs.aggs", + "type": "Array", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L62" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ] + }, + { + "id": "def-public.AggConfigs.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L65" + } + }, + { + "type": "Array", + "label": "configStates", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L66" + } + }, + { + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigsOptions", + "text": "AggConfigsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L64" + } + }, + { + "id": "def-public.AggConfigs.setTimeRange", + "type": "Function", + "label": "setTimeRange", + "signature": [ + "(timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void" + ], + "description": [], + "children": [ + { + "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/aggs/agg_configs.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79" + } + }, + { + "id": "def-public.AggConfigs.clone", + "type": "Function", + "label": "clone", + "signature": [ + "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ enabledOnly = true }", + "isRequired": true, + "signature": [ + "{ enabledOnly?: boolean | undefined; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97" + } + }, + { + "id": "def-public.AggConfigs.createAggConfig", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L111" + } + }, + { + "type": "Object", + "label": "{ addToAggConfigs = true }", + "isRequired": true, + "signature": [ + "{ addToAggConfigs?: boolean | undefined; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L112" + } + } + ], + "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" + } + ], + "description": [], + "label": "createAggConfig", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L110" + }, + "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" + ], + "children": [ + { + "type": "Array", + "label": "aggConfigs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [ + "an AggConfigs instance" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153" + } + }, + { + "id": "def-public.AggConfigs.toDsl", + "type": "Function", + "label": "toDsl", + "signature": [ + "(hierarchical?: boolean) => Record" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "hierarchical", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165" + } + }, + { + "id": "def-public.AggConfigs.getAll", + "type": "Function", + "label": "getAll", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L227" + } + }, + { + "id": "def-public.AggConfigs.byIndex", + "type": "Function", + "label": "byIndex", + "signature": [ + "(index: number) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "children": [ + { + "type": "number", + "label": "index", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231" + } + }, + { + "id": "def-public.AggConfigs.byId", + "type": "Function", + "label": "byId", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235" + } + }, + { + "id": "def-public.AggConfigs.byName", + "type": "Function", + "label": "byName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239" + } + }, + { + "id": "def-public.AggConfigs.byType", + "type": "Function", + "label": "byType", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243" + } + }, + { + "id": "def-public.AggConfigs.byTypeName", + "type": "Function", + "label": "byTypeName", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247" + } + }, + { + "id": "def-public.AggConfigs.bySchemaName", + "type": "Function", + "label": "bySchemaName", + "signature": [ + "(schema: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "schema", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251" + } + }, + { + "id": "def-public.AggConfigs.getRequestAggs", + "type": "Function", + "label": "getRequestAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L255" + } + }, + { + "id": "def-public.AggConfigs.getRequestAggById", + "type": "Function", + "label": "getRequestAggById", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269" + } + }, + { + "id": "def-public.AggConfigs.getResponseAggs", + "type": "Function", + "label": "getResponseAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "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": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L284" + } + }, + { + "id": "def-public.AggConfigs.getResponseAggById", + "type": "Function", + "label": "getResponseAggById", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | 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" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- the id of the agg to find" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298" + } + }, + { + "id": "def-public.AggConfigs.onSearchRequestStart", + "type": "Function", + "label": "onSearchRequestStart", + "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\">, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" + ], + "description": [], + "children": [ + { + "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/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + }, + { + "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/common/search/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggConfig", + "type": "Class", + "tags": [], + "label": "AggConfig", + "description": [], + "children": [ + { + "id": "def-public.AggConfig.ensureIds", + "type": "Function", + "label": "ensureIds", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".ensureIds" + ], + "description": [ + "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" + ], + "children": [ + { + "type": "Array", + "label": "list", + "isRequired": true, + "signature": [ + "any[]" + ], + "description": [ + "- a list of objects, objects can be anything really" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "- the list that was passed in" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63" + } + }, + { + "id": "def-public.AggConfig.nextId", + "type": "Function", + "label": "nextId", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".nextId" + ], + "description": [ + "\nCalculate the next id based on the ids in this list\n" + ], + "children": [ + { + "type": "Array", + "label": "list", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "list - a list of objects with id properties" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83" + } + }, + { + "tags": [], + "id": "def-public.AggConfig.aggConfigs", + "type": "Object", + "label": "aggConfigs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L92" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ] + }, + { + "tags": [], + "id": "def-public.AggConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L93" + } + }, + { + "tags": [], + "id": "def-public.AggConfig.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L94" + } + }, + { + "tags": [], + "id": "def-public.AggConfig.params", + "type": "Any", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L95" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.AggConfig.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L96" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AggConfig.brandNew", + "type": "CompoundType", + "label": "brandNew", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L97" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AggConfig.schema", + "type": "string", + "label": "schema", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L98" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.AggConfig.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "aggConfigs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + }, + { + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + }, + { + "id": "def-public.AggConfig.setParams", + "type": "Function", + "label": "setParams", + "signature": [ + "(from: any) => void" + ], + "description": [ + "\nWrite the current values to this.params, filling in the defaults as we go\n" + ], + "children": [ + { + "type": "Any", + "label": "from", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "- optional object to read values from,\n used when initializing" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134" + } + }, + { + "id": "def-public.AggConfig.getParam", + "type": "Function", + "label": "getParam", + "signature": [ + "(key: string) => any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171" + } + }, + { + "id": "def-public.AggConfig.write", + "type": "Function", + "label": "write", + "signature": [ + "(aggs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined) => Record" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "aggs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175" + } + }, + { + "id": "def-public.AggConfig.isFilterable", + "type": "Function", + "label": "isFilterable", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L179" + } + }, + { + "id": "def-public.AggConfig.createFilter", + "type": "Function", + "label": "createFilter", + "signature": [ + "(key: string, params?: {}) => any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "{}" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + }, + { + "id": "def-public.AggConfig.onSearchRequestStart", + "type": "Function", + "label": "onSearchRequestStart", + "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\">, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise | Promise" + ], + "description": [ + "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" + ], + "children": [ + { + "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/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + }, + { + "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/common/search/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + }, + { + "id": "def-public.AggConfig.toDsl", + "type": "Function", + "label": "toDsl", + "signature": [ + "(aggConfigs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined) => any" + ], + "description": [ + "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" + ], + "children": [ + { + "type": "Object", + "label": "aggConfigs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "description": [ + "- the config object to convert" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230" + } + }, + { + "id": "def-public.AggConfig.serialize", + "type": "Function", + "label": "serialize", + "signature": [ + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "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": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L259" + } + }, + { + "id": "def-public.AggConfig.toJSON", + "type": "Function", + "label": "toJSON", + "signature": [ + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; }" + ], + "description": [], + "children": [], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 290, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L290" + } + }, + { + "id": "def-public.AggConfig.toSerializedFieldFormat", + "type": "Function", + "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" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L301" + } + }, + { + "id": "def-public.AggConfig.toExpressionAst", + "type": "Function", + "label": "toExpressionAst", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | 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": 310, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L310" + } + }, + { + "id": "def-public.AggConfig.getAggParams", + "type": "Function", + "label": "getAggParams", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 365, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L365" + } + }, + { + "id": "def-public.AggConfig.getRequestAggs", + "type": "Function", + "label": "getRequestAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L369" + } + }, + { + "id": "def-public.AggConfig.getResponseAggs", + "type": "Function", + "label": "getResponseAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 373, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L373" + } + }, + { + "id": "def-public.AggConfig.getValue", + "type": "Function", + "label": "getValue", + "signature": [ + "(bucket: any) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "bucket", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 377, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 377, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377" + } + }, + { + "id": "def-public.AggConfig.getKey", + "type": "Function", + "label": "getKey", + "signature": [ + "(bucket: any, key?: string | undefined) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "bucket", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + }, + { + "type": "string", + "label": "key", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + }, + { + "id": "def-public.AggConfig.getFieldDisplayName", + "type": "Function", + "label": "getFieldDisplayName", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 389, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L389" + } + }, + { + "id": "def-public.AggConfig.getField", + "type": "Function", + "label": "getField", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L395" + } + }, + { + "id": "def-public.AggConfig.getValueBucketPath", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L404" + } + }, + { + "id": "def-public.AggConfig.makeLabel", + "type": "Function", + "label": "makeLabel", + "signature": [ + "(percentageMode?: boolean) => any" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "percentageMode", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408" + } + }, + { + "id": "def-public.AggConfig.getIndexPattern", + "type": "Function", + "label": "getIndexPattern", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L422" + } + }, + { + "id": "def-public.AggConfig.getTimeRange", + "type": "Function", + "label": "getTimeRange", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L426" + } + }, + { + "id": "def-public.AggConfig.fieldName", + "type": "Function", + "label": "fieldName", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 430, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L430" + } + }, + { + "id": "def-public.AggConfig.fieldIsTimeField", + "type": "Function", + "label": "fieldIsTimeField", + "signature": [ + "() => boolean | \"\" | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 435, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L435" + } + }, + { + "id": "def-public.AggConfig.type", + "type": "Object", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 442, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L442" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ] + }, + { + "id": "def-public.AggConfig.type", + "type": "Object", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L446" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ] + }, + { + "id": "def-public.AggConfig.setType", + "type": "Function", + "label": "setType", + "signature": [ + "(type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "type", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchSource", + "type": "Class", + "tags": [ + "public" + ], + "label": "SearchSource", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchSource.history", + "type": "Array", + "label": "history", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L112" + }, + "signature": [ + "Record[]" + ] + }, + { + "id": "def-public.SearchSource.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fields", + "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/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + }, + { + "type": "Object", + "label": "dependencies", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + }, + { + "id": "def-public.SearchSource.setPreferredSearchStrategyId", + "type": "Function", + "label": "setPreferredSearchStrategyId", + "signature": [ + "(searchStrategyId: string) => void" + ], + "description": [ + "**\nPUBLIC API\n\ninternal, dont use" + ], + "children": [ + { + "type": "string", + "label": "searchStrategyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134" + } + }, + { + "id": "def-public.SearchSource.setField", + "type": "Function", + "label": "setField", + "signature": [ + "(field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => this" + ], + "description": [ + "\nsets value to a single search source field" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [ + ": field name" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + }, + { + "type": "Uncategorized", + "label": "value", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + ": value for the field" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + }, + { + "id": "def-public.SearchSource.removeField", + "type": "Function", + "label": "removeField", + "signature": [ + "(field: K) => this" + ], + "description": [ + "\nremove field" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [ + ": field name" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155" + } + }, + { + "id": "def-public.SearchSource.setFields", + "type": "Function", + "label": "setFields", + "signature": [ + "(newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => this" + ], + "description": [ + "\nInternal, do not use. Overrides all search source fields with the new field array.\n" + ], + "children": [ + { + "type": "Object", + "label": "newFields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "New field array." + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166" + } + } + ], + "tags": [ + "private" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166" + } + }, + { + "id": "def-public.SearchSource.getId", + "type": "Function", + "label": "getId", + "signature": [ + "() => string" + ], + "description": [ + "\nreturns search source id" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L174" + } + }, + { + "id": "def-public.SearchSource.getFields", + "type": "Function", + "label": "getFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "\nreturns all search source fields" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L181" + } + }, + { + "id": "def-public.SearchSource.getField", + "type": "Function", + "label": "getField", + "signature": [ + "(field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + "\nGets a single field from the fields" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + }, + { + "type": "boolean", + "label": "recurse", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + }, + { + "id": "def-public.SearchSource.getOwnField", + "type": "Function", + "label": "getOwnField", + "signature": [ + "(field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + "\nGet the field from our own fields, don't traverse up the chain" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199" + } + }, + { + "id": "def-public.SearchSource.create", + "type": "Function", + "label": "create", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "description": [], + "children": [], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L206" + } + }, + { + "id": "def-public.SearchSource.createCopy", + "type": "Function", + "label": "createCopy", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "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": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L213" + } + }, + { + "id": "def-public.SearchSource.createChild", + "type": "Function", + "label": "createChild", + "signature": [ + "(options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "description": [ + "\ncreates a new child search source" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "{}" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227" + } + }, + { + "id": "def-public.SearchSource.setParent", + "type": "Function", + "label": "setParent", + "signature": [ + "(parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => this" + ], + "description": [ + "\nSet a searchSource that this source should inherit from" + ], + "children": [ + { + "type": "Object", + "label": "parent", + "isRequired": false, + "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\"> | undefined" + ], + "description": [ + "- the parent searchSource" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + } + ], + "description": [ + "- the inherit options" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "- chainable" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + }, + { + "id": "def-public.SearchSource.getParent", + "type": "Function", + "label": "getParent", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | 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": 249, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L249" + } + }, + { + "id": "def-public.SearchSource.fetch$", + "type": "Function", + "label": "fetch$", + "signature": [ + "(options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + "SearchResponse", + ">" + ], + "description": [ + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257" + } + }, + { + "id": "def-public.SearchSource.fetch", + "type": "Function", + "label": "fetch", + "signature": [ + "(options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse", + ">" + ], + "description": [ + "\nFetch this source and reject the returned Promise on error" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284" + } + } + ], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284" + } + }, + { + "id": "def-public.SearchSource.onRequestStart", + "type": "Function", + "label": "onRequestStart", + "signature": [ + "(handler: (searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void" + ], + "description": [ + "\n Add a handler that will be notified whenever requests start" + ], + "children": [ + { + "type": "Function", + "label": "handler", + "isRequired": true, + "signature": [ + "(searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L294" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L293" + } + }, + { + "id": "def-public.SearchSource.getSearchRequestBody", + "type": "Function", + "label": "getSearchRequestBody", + "signature": [ + "() => Promise" + ], + "description": [ + "\nReturns body contents of the search request, often referred as query DSL." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L302" + } + }, + { + "id": "def-public.SearchSource.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [ + "\nCompletely destroy the SearchSource." + ], + "children": [], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L311" + } + }, + { + "id": "def-public.SearchSource.getSerializedFields", + "type": "Function", + "label": "getSerializedFields", + "signature": [ + "(recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" + ], + "children": [ + { + "type": "boolean", + "label": "recurse", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 689, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 689, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689" + } + }, + { + "id": "def-public.SearchSource.serialize", + "type": "Function", + "label": "serialize", + "signature": [ + "() => { searchSourceJSON: string; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "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": 718, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L718" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPlugin", + "type": "Class", + "tags": [], + "label": "DataPublicPlugin", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPlugin", + "text": "DataPublicPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginSetup", + "text": "DataPublicPluginSetup" + }, + ", ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + }, + ", ", + "DataSetupDependencies" + ], + "children": [ + { + "id": "def-public.DataPublicPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L71" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L71" + } + }, + { + "id": "def-public.DataPublicPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + }, + ">, { bfetch, expressions, uiActions, usageCollection, inspector }: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataSetupDependencies", + "text": "DataSetupDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginSetup", + "text": "DataPublicPluginSetup" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L81" + } + }, + { + "type": "Object", + "label": "{ bfetch, expressions, uiActions, usageCollection, inspector }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataSetupDependencies", + "text": "DataSetupDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L82" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L80" + } + }, + { + "id": "def-public.DataPublicPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", { uiActions }: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131" + } + }, + { + "type": "Object", + "label": "{ uiActions }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131" + } + }, + { + "id": "def-public.DataPublicPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L213" + } + } + ], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L55" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.fieldList", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "specs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L35" + } + }, + { + "type": "boolean", + "label": "shortDotsEnable", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L36" + } + } + ], + "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" + } + ], + "description": [], + "label": "fieldList", + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L34" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.extractReferences", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L14" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getSearchParamsFromRequest", + "type": "Function", + "label": "getSearchParamsFromRequest", + "signature": [ + "(searchRequest: Record, dependencies: { getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + "; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "searchRequest", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L34" + } + }, + { + "id": "def-public.getSearchParamsFromRequest.dependencies", + "type": "Object", + "label": "dependencies", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.getSearchParamsFromRequest.dependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" + } + } + ], + "tags": [ + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-public.injectReferences", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "searchSourceFields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName: string; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L13" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L14" + } + } + ], + "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" + } + ], + "description": [], + "label": "injectReferences", + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L12" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.parseSearchSourceJSON", + "type": "Function", + "children": [ + { + "type": "string", + "label": "searchSourceJSON", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12" + } + } + ], + "signature": [ + "(searchSourceJSON: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [], + "label": "parseSearchSourceJSON", + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isErrorResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14" + }, + "tags": [], + "returnComment": [ + "true if response had an error while executing in ES" + ], + "initialIsOpen": false + }, + { + "id": "def-public.isCompleteResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21" + }, + "tags": [], + "returnComment": [ + "true if response is completed successfully" + ], + "initialIsOpen": false + }, + { + "id": "def-public.isPartialResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28" + }, + "tags": [], + "returnComment": [ + "true if request is still running an/d response contains partial results" + ], + "initialIsOpen": false + }, + { + "id": "def-public.getTime", + "type": "Function", + "label": "getTime", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38" + } + }, + { + "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/query/timefilter/get_time.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39" + } + }, + { + "id": "def-public.getTime.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.getTime.options.forceNow", + "type": "Object", + "label": "forceNow", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "Date | undefined" + ] + }, + { + "tags": [], + "id": "def-public.getTime.options.fieldName", + "type": "string", + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.castEsToKbnFieldTypeName", + "type": "Function", + "children": [ + { + "type": "string", + "label": "esType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + } + } + ], + "signature": [ + "(esType: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getKbnTypeNames", + "type": "Function", + "children": [], + "signature": [ + "() => string[]" + ], + "description": [ + "\n Get the esTypes known by all kbnFieldTypes\n" + ], + "label": "getKbnTypeNames", + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L30" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isTimeRange", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "description": [], + "label": "isTimeRange", + "source": { + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isQuery", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ], + "description": [], + "label": "isQuery", + "source": { + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isFilter", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "label": "isFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isFilters", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.RangeFilterParams", + "type": "Interface", + "label": "RangeFilterParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RangeFilterParams.from", + "type": "CompoundType", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L36" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.to", + "type": "CompoundType", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L37" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.gt", + "type": "CompoundType", + "label": "gt", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L38" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.lt", + "type": "CompoundType", + "label": "lt", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L39" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.gte", + "type": "CompoundType", + "label": "gte", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L40" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.lte", + "type": "CompoundType", + "label": "lte", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L41" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeFilterParams.format", + "type": "string", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L42" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EsQueryConfig", + "type": "Interface", + "label": "EsQueryConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EsQueryConfig.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.EsQueryConfig.queryStringOptions", + "type": "Object", + "label": "queryStringOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.EsQueryConfig.dateFormatTZ", + "type": "string", + "label": "dateFormatTZ", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.KueryNode", + "type": "Interface", + "label": "KueryNode", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.KueryNode.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12" + }, + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ] + }, + { + "id": "def-public.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatConfig", + "type": "Interface", + "label": "FieldFormatConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FieldFormatConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62" + } + }, + { + "tags": [], + "id": "def-public.FieldFormatConfig.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.FieldFormatConfig.es", + "type": "CompoundType", + "label": "es", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IIndexPatternFieldList", + "type": "Interface", + "label": "IIndexPatternFieldList", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.IIndexPatternFieldList.add", + "type": "Function", + "label": "add", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18" + } + }, + { + "id": "def-public.IIndexPatternFieldList.getAll", + "type": "Function", + "label": "getAll", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L19" + } + }, + { + "id": "def-public.IIndexPatternFieldList.getByName", + "type": "Function", + "label": "getByName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20" + } + }, + { + "id": "def-public.IIndexPatternFieldList.getByType", + "type": "Function", + "label": "getByType", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21" + } + }, + { + "id": "def-public.IIndexPatternFieldList.remove", + "type": "Function", + "label": "remove", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22" + } + }, + { + "id": "def-public.IIndexPatternFieldList.removeAll", + "type": "Function", + "label": "removeAll", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L23" + } + }, + { + "id": "def-public.IIndexPatternFieldList.replaceAll", + "type": "Function", + "label": "replaceAll", + "signature": [ + "(specs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "specs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24" + } + }, + { + "id": "def-public.IIndexPatternFieldList.update", + "type": "Function", + "label": "update", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25" + } + }, + { + "id": "def-public.IIndexPatternFieldList.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "(options?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; } | undefined) => Record ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IIndexPattern", + "type": "Interface", + "label": "IIndexPattern", + "description": [ + "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IIndexPattern.fields", + "type": "Array", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L32" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.IIndexPattern.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L33" + } + }, + { + "tags": [], + "id": "def-public.IIndexPattern.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L34" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IIndexPattern.type", + "type": "string", + "label": "type", + "description": [ + "\nType is used for identifying rollup indices, otherwise left undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L38" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IIndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L39" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.IIndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "(() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | undefined) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L40" + } + }, + { + "tags": [], + "id": "def-public.IIndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L41" + }, + "signature": [ + "Record | undefined> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IIndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "description": [ + "\nLook up a formatter for a given field" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L45" + }, + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IFieldType", + "type": "Interface", + "label": "IFieldType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IFieldType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.IFieldType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.IFieldType.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.sortable", + "type": "CompoundType", + "label": "sortable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.format", + "type": "Any", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31" + }, + "signature": [ + "((options?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IFieldSubType", + "type": "Interface", + "label": "IFieldSubType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IFieldSubType.multi", + "type": "Object", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154" + }, + "signature": [ + "{ parent: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IFieldSubType.nested", + "type": "Object", + "label": "nested", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155" + }, + "signature": [ + "{ path: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternAttributes", + "type": "Interface", + "label": "IndexPatternAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternAttributes.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.fields", + "type": "string", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.typeMeta", + "type": "string", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.sourceFilters", + "type": "string", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.fieldFormatMap", + "type": "string", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.fieldAttrs", + "type": "string", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.runtimeFieldMap", + "type": "string", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TypeMeta", + "type": "Interface", + "label": "TypeMeta", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.TypeMeta.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L159" + }, + "signature": [ + "Record> | undefined" + ] + }, + { + "id": "def-public.TypeMeta.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L160" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L158" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternSpec", + "type": "Interface", + "label": "IndexPatternSpec", + "description": [ + "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternSpec.id", + "type": "string", + "label": "id", + "description": [ + "\nsaved object id" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L228" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.version", + "type": "string", + "label": "version", + "description": [ + "\nsaved object version string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L232" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L233" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.IndexPatternSpec.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L238" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L239" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.sourceFilters", + "type": "Array", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L240" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.fields", + "type": "Object", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L241" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.typeMeta", + "type": "Object", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L242" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L243" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L244" + }, + "signature": [ + "Record>> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.runtimeFieldMap", + "type": "Object", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L245" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.fieldAttrs", + "type": "Object", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L246" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L247" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L224" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggFunctionsMapping", + "type": "Interface", + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggHistogram", + "type": "Object", + "label": "aggHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggTerms", + "type": "Object", + "label": "aggTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "label": "aggBucketAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggBucketMin", + "type": "Object", + "label": "aggBucketMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggBucketSum", + "type": "Object", + "label": "aggBucketSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggGeoBounds", + "type": "Object", + "label": "aggGeoBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMedian", + "type": "Object", + "label": "aggMedian", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggPercentiles", + "type": "Object", + "label": "aggPercentiles", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggSerialDiff", + "type": "Object", + "label": "aggSerialDiff", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggStdDeviation", + "type": "Object", + "label": "aggStdDeviation", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggSum", + "type": "Object", + "label": "aggSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggTopHit", + "type": "Object", + "label": "aggTopHit", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235" + }, + "signature": [ + "FunctionDefinition" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggParamOption", + "type": "Interface", + "label": "AggParamOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AggParamOption.val", + "type": "string", + "label": "val", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31" + } + }, + { + "tags": [], + "id": "def-public.AggParamOption.display", + "type": "string", + "label": "display", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32" + } + }, + { + "id": "def-public.AggParamOption.enabled", + "type": "Function", + "label": "enabled", + "signature": [ + "((agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean) | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agg", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OptionedValueProp", + "type": "Interface", + "label": "OptionedValueProp", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.OptionedValueProp.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.OptionedValueProp.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OptionedValueProp.isCompatible", + "type": "Function", + "label": "isCompatible", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IEsSearchRequest", + "type": "Interface", + "label": "IEsSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IKibanaSearchRequest", + "type": "Interface", + "label": "IKibanaSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IKibanaSearchRequest.id", + "type": "string", + "label": "id", + "description": [ + "\nAn id can be used to uniquely identify this request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L78" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchRequest.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L80" + }, + "signature": [ + "Params | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IKibanaSearchResponse", + "type": "Interface", + "label": "IKibanaSearchResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.id", + "type": "string", + "label": "id", + "description": [ + "\nSome responses may contain a unique id to identify the request this response came from." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L44" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.total", + "type": "number", + "label": "total", + "description": [ + "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L50" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.loaded", + "type": "number", + "label": "loaded", + "description": [ + "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L56" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.isRunning", + "type": "CompoundType", + "label": "isRunning", + "description": [ + "\nIndicates whether search is still in flight" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L61" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.isPartial", + "type": "CompoundType", + "label": "isPartial", + "description": [ + "\nIndicates whether the results returned are complete or partial" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L66" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IKibanaSearchResponse.rawResponse", + "type": "Uncategorized", + "label": "rawResponse", + "description": [ + "\nThe raw response returned by the internal search method (usually the raw ES response)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L71" + }, + "signature": [ + "RawResponse" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ISearchStartSearchSource", + "type": "Interface", + "label": "ISearchStartSearchSource", + "description": [ + "\nhigh level search service" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ISearchStartSearchSource.create", + "type": "Function", + "label": "create", + "description": [ + "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L30" + }, + "signature": [ + "(fields?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined) => Promise>" + ] + }, + { + "tags": [], + "id": "def-public.ISearchStartSearchSource.createEmpty", + "type": "Function", + "label": "createEmpty", + "description": [ + "\ncreates empty {@link SearchSource}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L34" + }, + "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\">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchSourceFields", + "type": "Interface", + "label": "SearchSourceFields", + "description": [ + "\nsearch source fields" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchSourceFields.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.query", + "type": "Object", + "label": "query", + "description": [ + "\n{@link Query}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L66" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.filter", + "type": "CompoundType", + "label": "filter", + "description": [ + "\n{@link Filter}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L70" + }, + "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" + }, + "[] | (() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.sort", + "type": "CompoundType", + "label": "sort", + "description": [ + "\n{@link EsQuerySortValue}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L74" + }, + "signature": [ + "Record | Record[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.highlight", + "type": "Any", + "label": "highlight", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L75" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.highlightAll", + "type": "CompoundType", + "label": "highlightAll", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L76" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.trackTotalHits", + "type": "CompoundType", + "label": "trackTotalHits", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L77" + }, + "signature": [ + "number | boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.aggs", + "type": "Any", + "label": "aggs", + "description": [ + "\n{@link AggConfigs}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L81" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L82" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L83" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.source", + "type": "CompoundType", + "label": "source", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L84" + }, + "signature": [ + "string | boolean | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.version", + "type": "CompoundType", + "label": "version", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L85" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.fields", + "type": "Array", + "label": "fields", + "description": [ + "\nRetrieve fields via the search Fields API" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L89" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchFieldValue", + "text": "SearchFieldValue" + }, + "[] | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", + "label": "fieldsFromSource", + "description": [ + "\nRetreive fields directly from _source (legacy behavior)\n" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L95" + }, + "signature": [ + "string | boolean | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.index", + "type": "Object", + "label": "index", + "description": [ + "\n{@link IndexPatternService}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L99" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.searchAfter", + "type": "Object", + "label": "searchAfter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L100" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.timeout", + "type": "string", + "label": "timeout", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L101" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.terminate_after", + "type": "number", + "label": "terminate_after", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L102" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchSourceFields.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L104" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchError", + "type": "Interface", + "label": "SearchError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchError.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-public.SearchError.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L38" + } + }, + { + "tags": [], + "id": "def-public.SearchError.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L39" + } + }, + { + "tags": [], + "id": "def-public.SearchError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L40" + } + }, + { + "tags": [], + "id": "def-public.SearchError.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L41" + } + }, + { + "tags": [], + "id": "def-public.SearchError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L42" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ISearchOptions", + "type": "Interface", + "label": "ISearchOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ISearchOptions.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87" + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.strategy", + "type": "string", + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.sessionId", + "type": "string", + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.isStored", + "type": "CompoundType", + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.isRestore", + "type": "CompoundType", + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchOptions.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RefreshInterval", + "type": "Interface", + "label": "RefreshInterval", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RefreshInterval.pause", + "type": "boolean", + "label": "pause", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.RefreshInterval.value", + "type": "number", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ApplyGlobalFilterActionContext", + "type": "Interface", + "label": "ApplyGlobalFilterActionContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ApplyGlobalFilterActionContext.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.ApplyGlobalFilterActionContext.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ApplyGlobalFilterActionContext.embeddable", + "type": "Unknown", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L23" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IDataPluginServices", + "type": "Interface", + "label": "IDataPluginServices", + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IDataPluginServices", + "text": "IDataPluginServices" + }, + " extends Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IDataPluginServices.appName", + "type": "string", + "label": "appName", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L116" + } + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L117" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L118" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsStart", + "text": "SavedObjectsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.notifications", + "type": "Object", + "label": "notifications", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L119" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.http", + "type": "Object", + "label": "http", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L120" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.storage", + "type": "Object", + "label": "storage", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L121" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IStorageWrapper", + "text": "IStorageWrapper" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L122" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } + ] + }, + { + "tags": [], + "id": "def-public.IDataPluginServices.usageCollection", + "type": "Object", + "label": "usageCollection", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L123" + }, + "signature": [ + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionStart", + "text": "UsageCollectionStart" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L115" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPluginStartUi", + "type": "Interface", + "label": "DataPublicPluginStartUi", + "description": [ + "\nData plugin prewired UI components" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DataPublicPluginStartUi.IndexPatternSelect", + "type": "CompoundType", + "label": "IndexPatternSelect", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L60" + }, + "signature": [ + "React.ComponentType<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.IndexPatternSelectProps", + "text": "IndexPatternSelectProps" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStartUi.SearchBar", + "type": "CompoundType", + "label": "SearchBar", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L61" + }, + "signature": [ + "React.ComponentType<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.StatefulSearchBarProps", + "text": "StatefulSearchBarProps" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L59" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPluginStartActions", + "type": "Interface", + "label": "DataPublicPluginStartActions", + "description": [ + "\nutilities to generate filters from action context" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DataPublicPluginStartActions.createFiltersFromValueClickAction", + "type": "Function", + "label": "createFiltersFromValueClickAction", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L68" + }, + "signature": [ + "({ data, negate, }: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.ValueClickDataContext", + "text": "ValueClickDataContext" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]>" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStartActions.createFiltersFromRangeSelectAction", + "type": "Function", + "label": "createFiltersFromRangeSelectAction", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L69" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.createFiltersFromRangeSelectAction", + "text": "createFiltersFromRangeSelectAction" + } + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L67" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.ES_FIELD_TYPES", + "type": "Enum", + "label": "ES_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.KBN_FIELD_TYPES", + "type": "Enum", + "label": "KBN_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-public.BUCKET_TYPES", + "type": "Enum", + "label": "BUCKET_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.METRIC_TYPES", + "type": "Enum", + "label": "METRIC_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SortDirection", + "type": "Enum", + "label": "SortDirection", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L39" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.RangeFilter", + "type": "Type", + "label": "RangeFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L60" + }, + "signature": [ + "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.RangeFilterMeta", + "type": "Type", + "label": "RangeFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L50" + }, + "signature": [ + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExistsFilter", + "type": "Type", + "label": "ExistsFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L18" + }, + "signature": [ + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PhrasesFilter", + "type": "Type", + "label": "PhrasesFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L19" + }, + "signature": [ + "Filter & { meta: PhrasesFilterMeta; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PhraseFilter", + "type": "Type", + "label": "PhraseFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L21" + }, + "signature": [ + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.CustomFilter", + "type": "Type", + "label": "CustomFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/custom_filter.ts#L11" + }, + "signature": [ + "Filter & { query: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.MatchAllFilter", + "type": "Type", + "label": "MatchAllFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L16" + }, + "signature": [ + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IFieldFormat", + "type": "Type", + "label": "IFieldFormat", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L69" + }, + "signature": [ + "FieldFormat" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IFieldFormatsRegistry", + "type": "Type", + "label": "IFieldFormatsRegistry", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11" + }, + "signature": [ + "{ init: (getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatsContentType", + "type": "Type", + "label": "FieldFormatsContentType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L14" + }, + "signature": [ + "\"html\" | \"text\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatsGetConfigFn", + "type": "Type", + "label": "FieldFormatsGetConfigFn", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67" + }, + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatId", + "type": "Type", + "label": "FieldFormatId", + "tags": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L74" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternsContract", + "type": "Type", + "label": "IndexPatternsContract", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 638, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L638" + }, + "signature": [ + "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => 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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggregationRestrictions", + "type": "Type", + "label": "AggregationRestrictions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L141" + }, + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "label": "IndexPatternLoadExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34" + }, + "signature": [ + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggGroupName", + "type": "Type", + "label": "AggGroupName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18" + }, + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggParam", + "type": "Type", + "label": "AggParam", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28" + }, + "signature": [ + "BaseParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggConfigOptions", + "type": "Type", + "label": "AggConfigOptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43" + }, + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EsaggsExpressionFunctionDefinition", + "type": "Type", + "label": "EsaggsExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35" + }, + "signature": [ + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IAggConfig", + "type": "Type", + "label": "IAggConfig", + "tags": [ + "name", + "description" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53" + }, + "signature": [ + "AggConfig" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IAggType", + "type": "Type", + "label": "IAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58" + }, + "signature": [ + "AggType>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IFieldParamType", + "type": "Type", + "label": "IFieldParamType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21" + }, + "signature": [ + "FieldParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IMetricAggType", + "type": "Type", + "label": "IMetricAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35" + }, + "signature": [ + "MetricAggType" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ParsedInterval", + "type": "Type", + "label": "ParsedInterval", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18" + }, + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionContextSearch", + "type": "Type", + "label": "ExecutionContextSearch", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14" + }, + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunctionKibana", + "type": "Type", + "label": "ExpressionFunctionKibana", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunctionKibanaContext", + "type": "Type", + "label": "ExpressionFunctionKibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana_context\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueSearchContext", + "type": "Type", + "label": "ExpressionValueSearchContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "id": "def-public.KibanaContext", + "type": "Type", + "label": "KibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ES_SEARCH_STRATEGY", + "type": "string", + "label": "ES_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13" + }, + "signature": [ + "\"es\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EsQuerySortValue", + "type": "Type", + "label": "EsQuerySortValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L49" + }, + "signature": [ + "{ [x: string]: SortDirection | SortDirectionNumeric; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IEsSearchResponse", + "type": "Type", + "label": "IEsSearchResponse", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23" + }, + "signature": [ + "IKibanaSearchResponse>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ISearchGeneric", + "type": "Type", + "label": "ISearchGeneric", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L13" + }, + "signature": [ + "(request: SearchStrategyRequest, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ISearchSource", + "type": "Type", + "label": "ISearchSource", + "tags": [ + "public" + ], + "description": [ + "\nsearch source interface" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L19" + }, + "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", + "docId": "kibDataPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + "SearchResponse", + ">; fetch: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse" + ], + "initialIsOpen": false + }, + { + "id": "def-public.Filter", + "type": "Type", + "label": "Filter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41" + }, + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.Query", + "type": "Type", + "label": "Query", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12" + }, + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TimeRange", + "type": "Type", + "label": "TimeRange", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17" + }, + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggsStart", + "type": "Type", + "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": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L139" + }, + "signature": [ + "{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ACTION_GLOBAL_APPLY_FILTER", + "type": "string", + "label": "ACTION_GLOBAL_APPLY_FILTER", + "description": [], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L16" + }, + "signature": [ + "\"ACTION_GLOBAL_APPLY_FILTER\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.APPLY_FILTER_TRIGGER", + "type": "string", + "label": "APPLY_FILTER_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/data/public/triggers/apply_filter_trigger.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/triggers/apply_filter_trigger.ts#L12" + }, + "signature": [ + "\"FILTER_TRIGGER\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.esFilters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.esFilters.FilterLabel", + "type": "Function", + "label": "FilterLabel", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L56" + }, + "signature": [ + "(props: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.FilterLabelProps", + "text": "FilterLabelProps" + }, + ") => JSX.Element" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.FILTERS", + "type": "Object", + "label": "FILTERS", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L58" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FILTERS", + "text": "FILTERS" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.FilterStateStore", + "type": "Object", + "label": "FilterStateStore", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L59" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildEmptyFilter", + "type": "Function", + "label": "buildEmptyFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L61" + }, + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildPhrasesFilter", + "type": "Function", + "label": "buildPhrasesFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L62" + }, + "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" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildExistsFilter", + "type": "Function", + "label": "buildExistsFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L63" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildPhraseFilter", + "type": "Function", + "label": "buildPhraseFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L64" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildQueryFilter", + "type": "Function", + "label": "buildQueryFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L65" + }, + "signature": [ + "(query: any, index: string, alias: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.buildRangeFilter", + "type": "Function", + "label": "buildRangeFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L66" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isPhraseFilter", + "type": "Function", + "label": "isPhraseFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L68" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isExistsFilter", + "type": "Function", + "label": "isExistsFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L69" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isPhrasesFilter", + "type": "Function", + "label": "isPhrasesFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L70" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isRangeFilter", + "type": "Function", + "label": "isRangeFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L71" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isMatchAllFilter", + "type": "Function", + "label": "isMatchAllFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L72" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilter", + "text": "MatchAllFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isMissingFilter", + "type": "Function", + "label": "isMissingFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L73" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isQueryStringFilter", + "type": "Function", + "label": "isQueryStringFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L74" + }, + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.isFilterPinned", + "type": "Function", + "label": "isFilterPinned", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L75" + }, + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.toggleFilterNegated", + "type": "Function", + "label": "toggleFilterNegated", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L77" + }, + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; query?: any; }" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.disableFilter", + "type": "Function", + "label": "disableFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L78" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.getPhraseFilterField", + "type": "Function", + "label": "getPhraseFilterField", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L79" + }, + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + }, + ") => string" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.getPhraseFilterValue", + "type": "Function", + "label": "getPhraseFilterValue", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L80" + }, + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + }, + ") => PhraseFilterValue" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.getDisplayValueFromFilter", + "type": "Function", + "label": "getDisplayValueFromFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L81" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.getDisplayValueFromFilter", + "text": "getDisplayValueFromFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.compareFilters", + "type": "Function", + "label": "compareFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L83" + }, + "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": [], + "id": "def-public.esFilters.COMPARE_ALL_OPTIONS", + "type": "Object", + "label": "COMPARE_ALL_OPTIONS", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L84" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.generateFilters", + "type": "Function", + "label": "generateFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L85" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.generateFilters", + "text": "generateFilters" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.onlyDisabledFiltersChanged", + "type": "Function", + "label": "onlyDisabledFiltersChanged", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L86" + }, + "signature": [ + "(newFilters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined, oldFilters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined) => boolean" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.changeTimeFilter", + "type": "Function", + "label": "changeTimeFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L88" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.changeTimeFilter", + "text": "changeTimeFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.convertRangeFilterToTimeRangeString", + "type": "Function", + "label": "convertRangeFilterToTimeRangeString", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L89" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.convertRangeFilterToTimeRangeString", + "text": "convertRangeFilterToTimeRangeString" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.mapAndFlattenFilters", + "type": "Function", + "label": "mapAndFlattenFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L90" + }, + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.esFilters.extractTimeFilter", + "type": "Function", + "label": "extractTimeFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L91" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.extractTimeFilter", + "text": "extractTimeFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.esFilters.extractTimeRange", + "type": "Function", + "label": "extractTimeRange", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L92" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.extractTimeRange", + "text": "extractTimeRange" + } + ] + } + ], + "description": [], + "label": "esFilters", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-public.esKuery", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.esKuery.nodeTypes", + "type": "Object", + "label": "nodeTypes", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L122" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.NodeTypes", + "text": "NodeTypes" + } + ] + }, + { + "tags": [], + "id": "def-public.esKuery.fromKueryExpression", + "type": "Function", + "label": "fromKueryExpression", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L123" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-public.esKuery.toElasticsearchQuery", + "type": "Function", + "label": "toElasticsearchQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L124" + }, + "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" + } + ] + } + ], + "description": [], + "label": "esKuery", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L121" + }, + "initialIsOpen": false + }, + { + "id": "def-public.esQuery", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.esQuery.buildEsQuery", + "type": "Function", + "label": "buildEsQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L128" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.buildEsQuery", + "text": "buildEsQuery" + } + ] + }, + { + "tags": [], + "id": "def-public.esQuery.getEsQueryConfig", + "type": "Function", + "label": "getEsQueryConfig", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L129" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.getEsQueryConfig", + "text": "getEsQueryConfig" + } + ] + }, + { + "tags": [], + "id": "def-public.esQuery.buildQueryFromFilters", + "type": "Function", + "label": "buildQueryFromFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L130" + }, + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "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" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-public.esQuery.luceneStringToDsl", + "type": "Function", + "label": "luceneStringToDsl", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L131" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.luceneStringToDsl", + "text": "luceneStringToDsl" + } + ] + }, + { + "tags": [], + "id": "def-public.esQuery.decorateQuery", + "type": "Function", + "label": "decorateQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L132" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.decorateQuery", + "text": "decorateQuery" + } + ] + } + ], + "description": [], + "label": "esQuery", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L127" + }, + "initialIsOpen": false + }, + { + "id": "def-public.fieldFormats", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.fieldFormats.FieldFormat", + "type": "Object", + "label": "FieldFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L168" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.FieldFormatsRegistry", + "type": "Object", + "label": "FieldFormatsRegistry", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L169" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.DEFAULT_CONVERTER_COLOR", + "type": "Object", + "label": "DEFAULT_CONVERTER_COLOR", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L171" + }, + "signature": [ + "{ range: string; regex: string; text: string; background: string; }" + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.HTML_CONTEXT_TYPE", + "type": "CompoundType", + "label": "HTML_CONTEXT_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L172" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.TEXT_CONTEXT_TYPE", + "type": "CompoundType", + "label": "TEXT_CONTEXT_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L173" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.FIELD_FORMAT_IDS", + "type": "Object", + "label": "FIELD_FORMAT_IDS", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L174" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.BoolFormat", + "type": "Object", + "label": "BoolFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L176" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BoolFormat", + "text": "BoolFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.BytesFormat", + "type": "Object", + "label": "BytesFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L177" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BytesFormat", + "text": "BytesFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.ColorFormat", + "type": "Object", + "label": "ColorFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L178" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.ColorFormat", + "text": "ColorFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.DateFormat", + "type": "Object", + "label": "DateFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L179" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-public.DateFormat", + "text": "DateFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.DateNanosFormat", + "type": "Object", + "label": "DateNanosFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L180" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.DateNanosFormat", + "text": "DateNanosFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.DurationFormat", + "type": "Object", + "label": "DurationFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L181" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.DurationFormat", + "text": "DurationFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.IpFormat", + "type": "Object", + "label": "IpFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L182" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IpFormat", + "text": "IpFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.NumberFormat", + "type": "Object", + "label": "NumberFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L183" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.NumberFormat", + "text": "NumberFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.PercentFormat", + "type": "Object", + "label": "PercentFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L184" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.PercentFormat", + "text": "PercentFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.RelativeDateFormat", + "type": "Object", + "label": "RelativeDateFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L185" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.RelativeDateFormat", + "text": "RelativeDateFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.SourceFormat", + "type": "Object", + "label": "SourceFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L186" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.SourceFormat", + "text": "SourceFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.StaticLookupFormat", + "type": "Object", + "label": "StaticLookupFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L187" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StaticLookupFormat", + "text": "StaticLookupFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.UrlFormat", + "type": "Object", + "label": "UrlFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L188" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.UrlFormat", + "text": "UrlFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.StringFormat", + "type": "Object", + "label": "StringFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L189" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StringFormat", + "text": "StringFormat" + } + ] + }, + { + "tags": [], + "id": "def-public.fieldFormats.TruncateFormat", + "type": "Object", + "label": "TruncateFormat", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L190" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TruncateFormat", + "text": "TruncateFormat" + } + ] + } + ], + "description": [], + "label": "fieldFormats", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L167" + }, + "initialIsOpen": false + }, + { + "id": "def-public.exporters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.exporters.datatableToCSV", + "type": "Function", + "label": "datatableToCSV", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L210" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } + ] + }, + { + "tags": [], + "id": "def-public.exporters.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L211" + } + } + ], + "description": [], + "label": "exporters", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L209" + }, + "initialIsOpen": false + }, + { + "id": "def-public.indexPatterns", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", + "type": "string", + "label": "ILLEGAL_CHARACTERS_KEY", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L235" + } + }, + { + "tags": [], + "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", + "type": "string", + "label": "CONTAINS_SPACES_KEY", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L236" + } + }, + { + "tags": [], + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "label": "ILLEGAL_CHARACTERS_VISIBLE", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L237" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", + "type": "Array", + "label": "ILLEGAL_CHARACTERS", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L238" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.isDefault", + "type": "Function", + "label": "isDefault", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L239" + }, + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.isFilterable", + "type": "Function", + "label": "isFilterable", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L240" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isFilterable", + "text": "isFilterable" + } + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.isNestedField", + "type": "Function", + "label": "isNestedField", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L241" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isNestedField", + "text": "isNestedField" + } + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L242" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.validateIndexPattern", + "text": "validateIndexPattern" + } + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.flattenHitWrapper", + "type": "Function", + "label": "flattenHitWrapper", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L243" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.flattenHitWrapper", + "text": "flattenHitWrapper" + } + ] + }, + { + "tags": [], + "id": "def-public.indexPatterns.formatHitProvider", + "type": "Function", + "label": "formatHitProvider", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L244" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.formatHitProvider", + "text": "formatHitProvider" + } + ] + } + ], + "description": [], + "label": "indexPatterns", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L234" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11" + }, + "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\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AggGroupLabels", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AggGroupLabels.[AggGroupNames.Buckets]", + "type": "string", + "label": "[AggGroupNames.Buckets]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.AggGroupLabels.[AggGroupNames.Metrics]", + "type": "string", + "label": "[AggGroupNames.Metrics]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.AggGroupLabels.[AggGroupNames.None]", + "type": "string", + "label": "[AggGroupNames.None]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27" + } + } + ], + "description": [], + "label": "AggGroupLabels", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12" + }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.search", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-public.search.aggs", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.search.aggs.CidrMask", + "type": "Object", + "label": "CidrMask", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 401, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L401" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.dateHistogramInterval", + "type": "Function", + "label": "dateHistogramInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 402, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L402" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.dateHistogramInterval", + "text": "dateHistogramInterval" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.intervalOptions", + "type": "Array", + "label": "intervalOptions", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 403, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L403" + }, + "signature": [ + "({ display: string; val: string; enabled(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", + "type": "Object", + "label": "InvalidEsCalendarIntervalError", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L404" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.InvalidEsIntervalFormatError", + "type": "Object", + "label": "InvalidEsIntervalFormatError", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 405, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L405" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.Ipv4Address", + "type": "Object", + "label": "Ipv4Address", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 406, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L406" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.Ipv4Address", + "text": "Ipv4Address" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", + "type": "Function", + "label": "isDateHistogramBucketAggConfig", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 407, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L407" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isDateHistogramBucketAggConfig", + "text": "isDateHistogramBucketAggConfig" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isNumberType", + "type": "Function", + "label": "isNumberType", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L408" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isStringType", + "type": "Function", + "label": "isStringType", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 409, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L409" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isType", + "type": "Function", + "label": "isType", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 410, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L410" + }, + "signature": [ + "(...types: string[]) => (agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isValidEsInterval", + "type": "Function", + "label": "isValidEsInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 411, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L411" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidEsInterval", + "text": "isValidEsInterval" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.isValidInterval", + "type": "Function", + "label": "isValidInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 412, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L412" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidInterval", + "text": "isValidInterval" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.parentPipelineType", + "type": "string", + "label": "parentPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 413, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L413" + } + }, + { + "tags": [], + "id": "def-public.search.aggs.parseEsInterval", + "type": "Function", + "label": "parseEsInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L414" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseEsInterval", + "text": "parseEsInterval" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.parseInterval", + "type": "Function", + "label": "parseInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 415, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L415" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseInterval", + "text": "parseInterval" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.propFilter", + "type": "Function", + "label": "propFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 416, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L416" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.propFilter", + "text": "propFilter" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.siblingPipelineType", + "type": "string", + "label": "siblingPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 417, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L417" + } + }, + { + "tags": [], + "id": "def-public.search.aggs.termsAggFilter", + "type": "Array", + "label": "termsAggFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 418, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L418" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.toAbsoluteDates", + "type": "Function", + "label": "toAbsoluteDates", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 419, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L419" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.toAbsoluteDates", + "text": "toAbsoluteDates" + } + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.boundsDescendingRaw", + "type": "Array", + "label": "boundsDescendingRaw", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 420, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L420" + }, + "signature": [ + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + ] + }, + { + "tags": [], + "id": "def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn", + "type": "Function", + "label": "getNumberHistogramIntervalByDatatableColumn", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 421, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L421" + }, + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => number | undefined" + ] + } + ], + "description": [], + "label": "aggs", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 400, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L400" + } + }, + { + "tags": [], + "id": "def-public.search.getRequestInspectorStats", + "type": "Function", + "label": "getRequestInspectorStats", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 423, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L423" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.getRequestInspectorStats", + "text": "getRequestInspectorStats" + } + ] + }, + { + "tags": [], + "id": "def-public.search.getResponseInspectorStats", + "type": "Function", + "label": "getResponseInspectorStats", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 424, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L424" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.getResponseInspectorStats", + "text": "getResponseInspectorStats" + } + ] + }, + { + "tags": [], + "id": "def-public.search.tabifyAggResponse", + "type": "Function", + "label": "tabifyAggResponse", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 425, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L425" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.tabifyAggResponse", + "text": "tabifyAggResponse" + } + ] + }, + { + "tags": [], + "id": "def-public.search.tabifyGetColumns", + "type": "Function", + "label": "tabifyGetColumns", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L426" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.tabifyGetColumns", + "text": "tabifyGetColumns" + } + ] + } + ], + "description": [], + "label": "search", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 399, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L399" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-public.DataPublicPluginSetup", + "type": "Interface", + "label": "DataPublicPluginSetup", + "description": [ + "\nData plugin public Setup contract" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DataPublicPluginSetup.autocomplete", + "type": "Object", + "label": "autocomplete", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L46" + }, + "signature": [ + "{ addQuerySuggestionProvider: (language: string, provider: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + ") => void; getQuerySuggestions: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginSetup.search", + "type": "Object", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L47" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchSetup", + "text": "ISearchSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginSetup.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L48" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"register\">" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginSetup.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L49" + }, + "signature": [ + "{ filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, + "; queryString: Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringManager", + "text": "QueryStringManager" + }, + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ", + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + } + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L45" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.DataPublicPluginStart", + "type": "Interface", + "label": "DataPublicPluginStart", + "description": [ + "\nData plugin public Start contract" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DataPublicPluginStart.actions", + "type": "Object", + "label": "actions", + "description": [ + "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L80" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStartActions", + "text": "DataPublicPluginStartActions" + } + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.autocomplete", + "type": "Object", + "label": "autocomplete", + "description": [ + "\nautocomplete service\n{@link AutocompleteStart}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L85" + }, + "signature": [ + "{ getQuerySuggestions: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.ValueSuggestionsGetFn", + "text": "ValueSuggestionsGetFn" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.indexPatterns", + "type": "Object", + "label": "indexPatterns", + "description": [ + "\nindex patterns service\n{@link IndexPatternsContract}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L90" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.search", + "type": "Object", + "label": "search", + "description": [ + "\nsearch service\n{@link ISearchStart}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L95" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchStart", + "text": "ISearchStart" + } + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.fieldFormats", + "type": "CompoundType", + "label": "fieldFormats", + "description": [ + "\nfield formats service\n{@link FieldFormatsStart}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L100" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-public.FieldFormatsStart", + "text": "FieldFormatsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.query", + "type": "Object", + "label": "query", + "description": [ + "\nquery service\n{@link QueryStart}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L105" + }, + "signature": [ + "{ 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<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringManager", + "text": "QueryStringManager" + }, + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + }, + "; state$: ", + "Observable" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.ui", + "type": "Object", + "label": "ui", + "description": [ + "\nprewired UI components\n{@link DataPublicPluginStartUi}" + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L110" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStartUi", + "text": "DataPublicPluginStartUi" + } + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStart.nowProvider", + "type": "Object", + "label": "nowProvider", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L112" + }, + "signature": [ + "Pick, \"get\">" + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L75" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "id": "def-server.IndexPattern", + "type": "Class", + "tags": [], + "label": "IndexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " implements ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "children": [ + { + "tags": [], + "id": "def-server.IndexPattern.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46" + } + }, + { + "tags": [], + "id": "def-server.IndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.typeMeta", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.fields", + "type": "CompoundType", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => Record; }" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.IndexPattern.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.type", + "type": "string", + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.formatHit", + "type": "Function", + "label": "formatHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63" + }, + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.formatField", + "type": "Function", + "label": "formatField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67" + }, + "signature": [ + "FormatFieldFn" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.flattenHit", + "type": "Function", + "label": "flattenHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68" + }, + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.version", + "type": "string", + "label": "version", + "description": [ + "\nSavedObject version" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.sourceFilters", + "type": "Array", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPattern.allowNoIndex", + "type": "boolean", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84" + } + }, + { + "id": "def-server.IndexPattern.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", + "isRequired": true, + "signature": [ + "IndexPatternDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + }, + { + "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; }" + ], + "description": [ + "\nGet last saved saved object fields" + ], + "label": "getOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPattern.resetOriginalSavedObjectBody", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [ + "\nReset last saved saved object fields. used after saving" + ], + "label": "resetOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPattern.getFieldAttrs", + "type": "Function", + "children": [], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "description": [], + "label": "getFieldAttrs", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPattern.getComputedFields", + "type": "Function", + "label": "getComputedFields", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162" + } + }, + { + "id": "def-server.IndexPattern.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208" + } + }, + { + "id": "def-server.IndexPattern.getSourceFiltering", + "type": "Function", + "label": "getSourceFiltering", + "signature": [ + "() => { excludes: any[]; }" + ], + "description": [ + "\nGet the source filtering configuration for that index." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230" + } + }, + { + "id": "def-server.IndexPattern.addScriptedField", + "type": "Function", + "label": "addScriptedField", + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "description": [ + "\nAdd scripted field to field list\n" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "script", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "script code" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "fieldType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "id": "def-server.IndexPattern.removeScriptedField", + "type": "Function", + "label": "removeScriptedField", + "signature": [ + "(fieldName: string) => void" + ], + "description": [ + "\nRemove scripted field from field list" + ], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + }, + { + "id": "def-server.IndexPattern.getNonScriptedFields", + "type": "Function", + "label": "getNonScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277" + } + }, + { + "id": "def-server.IndexPattern.getScriptedFields", + "type": "Function", + "label": "getScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281" + } + }, + { + "id": "def-server.IndexPattern.isTimeBased", + "type": "Function", + "label": "isTimeBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285" + } + }, + { + "id": "def-server.IndexPattern.isTimeNanosBased", + "type": "Function", + "label": "isTimeNanosBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289" + } + }, + { + "id": "def-server.IndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294" + } + }, + { + "id": "def-server.IndexPattern.getFieldByName", + "type": "Function", + "label": "getFieldByName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + }, + { + "id": "def-server.IndexPattern.getAggregationRestrictions", + "type": "Function", + "label": "getAggregationRestrictions", + "signature": [ + "() => Record> | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304" + } + }, + { + "id": "def-server.IndexPattern.getAsSavedObjectBody", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311" + } + }, + { + "id": "def-server.IndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "description": [ + "\nProvide a field, get its formatter" + ], + "children": [ + { + "type": "CompoundType", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 340, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339" + } + }, + { + "id": "def-server.IndexPattern.addRuntimeField", + "type": "Function", + "label": "addRuntimeField", + "signature": [ + "(name: string, runtimeField: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => void" + ], + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "type": "Object", + "label": "runtimeField", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "description": [ + "Runtime field definition" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "id": "def-server.IndexPattern.removeRuntimeField", + "type": "Function", + "label": "removeRuntimeField", + "signature": [ + "(name: string) => void" + ], + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + }, + { + "id": "def-server.IndexPattern.getFormatterForFieldNoDefault", + "type": "Function", + "label": "getFormatterForFieldNoDefault", + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], + "children": [ + { + "type": "string", + "label": "fieldname", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + }, + { + "id": "def-server.IndexPattern.setFieldAttrs", + "type": "Function", + "label": "setFieldAttrs", + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 412, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412" + } + }, + { + "type": "Uncategorized", + "label": "attrName", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 413, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413" + } + }, + { + "type": "Uncategorized", + "label": "value", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411" + } + }, + { + "id": "def-server.IndexPattern.setFieldCustomLabel", + "type": "Function", + "label": "setFieldCustomLabel", + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "type": "CompoundType", + "label": "customLabel", + "isRequired": false, + "signature": [ + "string | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "id": "def-server.IndexPattern.setFieldCount", + "type": "Function", + "label": "setFieldCount", + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "type": "CompoundType", + "label": "count", + "isRequired": false, + "signature": [ + "number | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "id": "def-server.IndexPattern.setFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + }, + { + "type": "Object", + "label": "format", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPattern.deleteFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + } + } + ], + "signature": [ + "(fieldName: string) => void" + ], + "description": [], + "label": "deleteFieldFormat", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", + "type": "Function", + "label": "ensureDefaultIndexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-server.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "isRequired": true, + "signature": [ + "IndexPatternsServiceDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + }, + { + "id": "def-server.IndexPatternsService.getIds", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getTitles", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.find", + "type": "Function", + "children": [ + { + "type": "string", + "label": "search", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + }, + { + "type": "number", + "label": "size", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] + }, + { + "id": "def-server.IndexPatternsService.getIdsWithTitle", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.clearCache", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getCache", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" + }, + ">[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>" + ], + "description": [ + "\nGet default index pattern" + ], + "label": "getDefault", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.setDefault", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + }, + { + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getFieldsForWildcard", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + } + } + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "description": [ + "\nGet field list by providing { pattern }" + ], + "label": "getFieldsForWildcard", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237" + } + } + ], + "signature": [ + "(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", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], + "label": "getFieldsForIndexPattern", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + } + } + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise" + ], + "description": [ + "\nRefresh field list for a given index pattern" + ], + "label": "refreshFields", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "fields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + }, + { + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" + ], + "description": [ + "\nConverts field array to map" + ], + "label": "fieldArrayToMap", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObject", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + } + } + ], + "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] + }, + { + "id": "def-server.IndexPatternsService.get", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + } + } + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "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": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.create", + "type": "Function", + "label": "create", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern instance" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + } + ], + "tags": [], + "returnComment": [ + "IndexPattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "id": "def-server.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern and save it right away" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Whether to skip field refresh step." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "id": "def-server.IndexPatternsService.createSavedObject", + "type": "Function", + "label": "createSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nSave a new index pattern" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "id": "def-server.IndexPatternsService.updateSavedObject", + "type": "Function", + "label": "updateSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547" + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548" + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" + } + }, + { + "id": "def-server.IndexPatternsService.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "description": [ + "\nDeletes an index pattern from .kibana index" + ], + "children": [ + { + "type": "string", + "label": "indexPatternId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", + "type": "Function", + "label": "ensureDefaultIndexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-server.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "isRequired": true, + "signature": [ + "IndexPatternsServiceDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + }, + { + "id": "def-server.IndexPatternsService.getIds", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getTitles", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.find", + "type": "Function", + "children": [ + { + "type": "string", + "label": "search", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + }, + { + "type": "number", + "label": "size", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] + }, + { + "id": "def-server.IndexPatternsService.getIdsWithTitle", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.clearCache", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getCache", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" + }, + ">[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>" + ], + "description": [ + "\nGet default index pattern" + ], + "label": "getDefault", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.setDefault", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + }, + { + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getFieldsForWildcard", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + } + } + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "description": [ + "\nGet field list by providing { pattern }" + ], + "label": "getFieldsForWildcard", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237" + } + } + ], + "signature": [ + "(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", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], + "label": "getFieldsForIndexPattern", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + } + } + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise" + ], + "description": [ + "\nRefresh field list for a given index pattern" + ], + "label": "refreshFields", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "fields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + }, + { + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" + ], + "description": [ + "\nConverts field array to map" + ], + "label": "fieldArrayToMap", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObject", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + } + } + ], + "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] + }, + { + "id": "def-server.IndexPatternsService.get", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + } + } + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "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": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.create", + "type": "Function", + "label": "create", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern instance" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + } + ], + "tags": [], + "returnComment": [ + "IndexPattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "id": "def-server.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern and save it right away" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Whether to skip field refresh step." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "id": "def-server.IndexPatternsService.createSavedObject", + "type": "Function", + "label": "createSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nSave a new index pattern" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "id": "def-server.IndexPatternsService.updateSavedObject", + "type": "Function", + "label": "updateSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547" + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548" + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" + } + }, + { + "id": "def-server.IndexPatternsService.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "description": [ + "\nDeletes an index pattern from .kibana index" + ], + "children": [ + { + "type": "string", + "label": "indexPatternId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AggParamType", + "type": "Class", + "tags": [], + "label": "AggParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-server.AggParamType.makeAgg", + "type": "Function", + "label": "makeAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15" + }, + "signature": [ + "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" + ] + }, + { + "tags": [], + "id": "def-server.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16" + }, + "signature": [ + "string[]" + ] + }, + { + "id": "def-server.AggParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OptionedParamType", + "type": "Class", + "tags": [], + "label": "OptionedParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedParamType", + "text": "OptionedParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-server.OptionedParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" + }, + "[]" + ] + }, + { + "id": "def-server.OptionedParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DataServerPlugin", + "type": "Class", + "tags": [], + "label": "DataServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataServerPlugin", + "text": "DataServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetup", + "text": "DataPluginSetup" + }, + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ", ", + "DataPluginSetupDependencies" + ], + "children": [ + { + "id": "def-server.DataServerPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L69" + } + }, + { + "id": "def-server.DataServerPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStartDependencies", + "text": "DataPluginStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">, { bfetch, expressions, usageCollection }: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetupDependencies", + "text": "DataPluginSetupDependencies" + }, + ") => { __enhance: (enhancements: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataEnhancements", + "text": "DataEnhancements" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStartDependencies", + "text": "DataPluginStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L78" + } + }, + { + "type": "Object", + "label": "{ bfetch, expressions, usageCollection }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetupDependencies", + "text": "DataPluginSetupDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L79" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L77" + } + }, + { + "id": "def-server.DataServerPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => { fieldFormats: { fieldFormatServiceFactory: (uiSettings: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ">; }; indexPatterns: { indexPatternsServiceFactory: (savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L104" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L104" + } + }, + { + "id": "def-server.DataServerPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L118" + } + } + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L52" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-server.castEsToKbnFieldTypeName", + "type": "Function", + "children": [ + { + "type": "string", + "label": "esType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + } + } + ], + "signature": [ + "(esType: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.getTime", + "type": "Function", + "label": "getTime", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38" + } + }, + { + "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/query/timefilter/get_time.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39" + } + }, + { + "id": "def-server.getTime.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.getTime.options.forceNow", + "type": "Object", + "label": "forceNow", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "Date | undefined" + ] + }, + { + "tags": [], + "id": "def-server.getTime.options.fieldName", + "type": "string", + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-server.parseInterval", + "type": "Function", + "label": "parseInterval", + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "description": [], + "children": [ + { + "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": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.EsQueryConfig", + "type": "Interface", + "label": "EsQueryConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EsQueryConfig.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18" + } + }, + { + "tags": [], + "id": "def-server.EsQueryConfig.queryStringOptions", + "type": "Object", + "label": "queryStringOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.EsQueryConfig.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20" + } + }, + { + "tags": [], + "id": "def-server.EsQueryConfig.dateFormatTZ", + "type": "string", + "label": "dateFormatTZ", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.KueryNode", + "type": "Interface", + "label": "KueryNode", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.KueryNode.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12" + }, + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ] + }, + { + "id": "def-server.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FieldFormatConfig", + "type": "Interface", + "label": "FieldFormatConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FieldFormatConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62" + } + }, + { + "tags": [], + "id": "def-server.FieldFormatConfig.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.FieldFormatConfig.es", + "type": "CompoundType", + "label": "es", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IFieldType", + "type": "Interface", + "label": "IFieldType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IFieldType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-server.IFieldType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.IFieldType.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.sortable", + "type": "CompoundType", + "label": "sortable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.format", + "type": "Any", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31" + }, + "signature": [ + "((options?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IFieldSubType", + "type": "Interface", + "label": "IFieldSubType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IFieldSubType.multi", + "type": "Object", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154" + }, + "signature": [ + "{ parent: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IFieldSubType.nested", + "type": "Object", + "label": "nested", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155" + }, + "signature": [ + "{ path: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternAttributes", + "type": "Interface", + "label": "IndexPatternAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternAttributes.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.fields", + "type": "string", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.typeMeta", + "type": "string", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.sourceFilters", + "type": "string", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.fieldFormatMap", + "type": "string", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.fieldAttrs", + "type": "string", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.runtimeFieldMap", + "type": "string", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AggFunctionsMapping", + "type": "Interface", + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggHistogram", + "type": "Object", + "label": "aggHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggTerms", + "type": "Object", + "label": "aggTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "label": "aggBucketAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggBucketMin", + "type": "Object", + "label": "aggBucketMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggBucketSum", + "type": "Object", + "label": "aggBucketSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggGeoBounds", + "type": "Object", + "label": "aggGeoBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggMedian", + "type": "Object", + "label": "aggMedian", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggPercentiles", + "type": "Object", + "label": "aggPercentiles", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggSerialDiff", + "type": "Object", + "label": "aggSerialDiff", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggStdDeviation", + "type": "Object", + "label": "aggStdDeviation", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggSum", + "type": "Object", + "label": "aggSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggTopHit", + "type": "Object", + "label": "aggTopHit", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235" + }, + "signature": [ + "FunctionDefinition" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AggParamOption", + "type": "Interface", + "label": "AggParamOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AggParamOption.val", + "type": "string", + "label": "val", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31" + } + }, + { + "tags": [], + "id": "def-server.AggParamOption.display", + "type": "string", + "label": "display", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32" + } + }, + { + "id": "def-server.AggParamOption.enabled", + "type": "Function", + "label": "enabled", + "signature": [ + "((agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean) | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agg", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-server.OptionedValueProp", + "type": "Interface", + "label": "OptionedValueProp", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.OptionedValueProp.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14" + } + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.isCompatible", + "type": "Function", + "label": "isCompatible", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ISearchOptions", + "type": "Interface", + "label": "ISearchOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ISearchOptions.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87" + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.strategy", + "type": "string", + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.sessionId", + "type": "string", + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.isStored", + "type": "CompoundType", + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.isRestore", + "type": "CompoundType", + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchOptions.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IEsSearchRequest", + "type": "Interface", + "label": "IEsSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RefreshInterval", + "type": "Interface", + "label": "RefreshInterval", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.RefreshInterval.pause", + "type": "boolean", + "label": "pause", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-server.RefreshInterval.value", + "type": "number", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-server.ES_FIELD_TYPES", + "type": "Enum", + "label": "ES_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-server.KBN_FIELD_TYPES", + "type": "Enum", + "label": "KBN_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.BUCKET_TYPES", + "type": "Enum", + "label": "BUCKET_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-server.METRIC_TYPES", + "type": "Enum", + "label": "METRIC_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-server.IFieldFormatsRegistry", + "type": "Type", + "label": "IFieldFormatsRegistry", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11" + }, + "signature": [ + "{ init: (getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.FieldFormatsGetConfigFn", + "type": "Type", + "label": "FieldFormatsGetConfigFn", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67" + }, + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "label": "IndexPatternLoadExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34" + }, + "signature": [ + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AggGroupName", + "type": "Type", + "label": "AggGroupName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18" + }, + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AggParam", + "type": "Type", + "label": "AggParam", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28" + }, + "signature": [ + "BaseParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AggConfigOptions", + "type": "Type", + "label": "AggConfigOptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43" + }, + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.EsaggsExpressionFunctionDefinition", + "type": "Type", + "label": "EsaggsExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35" + }, + "signature": [ + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IAggConfig", + "type": "Type", + "label": "IAggConfig", + "tags": [ + "name", + "description" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53" + }, + "signature": [ + "AggConfig" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IAggType", + "type": "Type", + "label": "IAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58" + }, + "signature": [ + "AggType>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IFieldParamType", + "type": "Type", + "label": "IFieldParamType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21" + }, + "signature": [ + "FieldParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IMetricAggType", + "type": "Type", + "label": "IMetricAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35" + }, + "signature": [ + "MetricAggType" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ParsedInterval", + "type": "Type", + "label": "ParsedInterval", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18" + }, + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExecutionContextSearch", + "type": "Type", + "label": "ExecutionContextSearch", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14" + }, + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionKibana", + "type": "Type", + "label": "ExpressionFunctionKibana", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionKibanaContext", + "type": "Type", + "label": "ExpressionFunctionKibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana_context\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueSearchContext", + "type": "Type", + "label": "ExpressionValueSearchContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "id": "def-server.KibanaContext", + "type": "Type", + "label": "KibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IEsSearchResponse", + "type": "Type", + "label": "IEsSearchResponse", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23" + }, + "signature": [ + "IKibanaSearchResponse>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.ES_SEARCH_STRATEGY", + "type": "string", + "label": "ES_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13" + }, + "signature": [ + "\"es\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.Filter", + "type": "Type", + "label": "Filter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41" + }, + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.Query", + "type": "Type", + "label": "Query", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12" + }, + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.TimeRange", + "type": "Type", + "label": "TimeRange", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17" + }, + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-server.esFilters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.esFilters.buildQueryFilter", + "type": "Function", + "label": "buildQueryFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L30" + }, + "signature": [ + "(query: any, index: string, alias: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildCustomFilter", + "type": "Function", + "label": "buildCustomFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L31" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.buildCustomFilter", + "text": "buildCustomFilter" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildEmptyFilter", + "type": "Function", + "label": "buildEmptyFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L32" + }, + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildExistsFilter", + "type": "Function", + "label": "buildExistsFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L33" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildFilter", + "type": "Function", + "label": "buildFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L34" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.buildFilter", + "text": "buildFilter" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildPhraseFilter", + "type": "Function", + "label": "buildPhraseFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L35" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildPhrasesFilter", + "type": "Function", + "label": "buildPhrasesFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L36" + }, + "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" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.buildRangeFilter", + "type": "Function", + "label": "buildRangeFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L37" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-server.esFilters.isFilterDisabled", + "type": "Function", + "label": "isFilterDisabled", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L38" + }, + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => boolean" + ] + } + ], + "description": [], + "label": "esFilters", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.exporters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.exporters.datatableToCSV", + "type": "Function", + "label": "datatableToCSV", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L47" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } + ] + }, + { + "tags": [], + "id": "def-server.exporters.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L48" + } + } + ], + "description": [], + "label": "exporters", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-server.esKuery", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.esKuery.nodeTypes", + "type": "Object", + "label": "nodeTypes", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L65" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.NodeTypes", + "text": "NodeTypes" + } + ] + }, + { + "tags": [], + "id": "def-server.esKuery.fromKueryExpression", + "type": "Function", + "label": "fromKueryExpression", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L66" + }, + "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" + } + ] + }, + { + "tags": [], + "id": "def-server.esKuery.toElasticsearchQuery", + "type": "Function", + "label": "toElasticsearchQuery", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L67" + }, + "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" + } + ] + } + ], + "description": [], + "label": "esKuery", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-server.esQuery", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.esQuery.buildQueryFromFilters", + "type": "Function", + "label": "buildQueryFromFilters", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L71" + }, + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "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" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-server.esQuery.getEsQueryConfig", + "type": "Function", + "label": "getEsQueryConfig", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L72" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.getEsQueryConfig", + "text": "getEsQueryConfig" + } + ] + }, + { + "tags": [], + "id": "def-server.esQuery.buildEsQuery", + "type": "Function", + "label": "buildEsQuery", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L73" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.buildEsQuery", + "text": "buildEsQuery" + } + ] + } + ], + "description": [], + "label": "esQuery", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-server.fieldFormats", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.fieldFormats.FieldFormatsRegistry", + "type": "Object", + "label": "FieldFormatsRegistry", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L101" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.FieldFormat", + "type": "Object", + "label": "FieldFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L102" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.BoolFormat", + "type": "Object", + "label": "BoolFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L103" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BoolFormat", + "text": "BoolFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.BytesFormat", + "type": "Object", + "label": "BytesFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L104" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BytesFormat", + "text": "BytesFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.ColorFormat", + "type": "Object", + "label": "ColorFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L105" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.ColorFormat", + "text": "ColorFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.DurationFormat", + "type": "Object", + "label": "DurationFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L106" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.DurationFormat", + "text": "DurationFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.IpFormat", + "type": "Object", + "label": "IpFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L107" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IpFormat", + "text": "IpFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.NumberFormat", + "type": "Object", + "label": "NumberFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L108" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.NumberFormat", + "text": "NumberFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.PercentFormat", + "type": "Object", + "label": "PercentFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L109" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.PercentFormat", + "text": "PercentFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.RelativeDateFormat", + "type": "Object", + "label": "RelativeDateFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L110" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.RelativeDateFormat", + "text": "RelativeDateFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.SourceFormat", + "type": "Object", + "label": "SourceFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L111" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.SourceFormat", + "text": "SourceFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.StaticLookupFormat", + "type": "Object", + "label": "StaticLookupFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L112" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StaticLookupFormat", + "text": "StaticLookupFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.UrlFormat", + "type": "Object", + "label": "UrlFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L113" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.UrlFormat", + "text": "UrlFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.StringFormat", + "type": "Object", + "label": "StringFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L114" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StringFormat", + "text": "StringFormat" + } + ] + }, + { + "tags": [], + "id": "def-server.fieldFormats.TruncateFormat", + "type": "Object", + "label": "TruncateFormat", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L115" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TruncateFormat", + "text": "TruncateFormat" + } + ] + } + ], + "description": [], + "label": "fieldFormats", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L100" + }, + "initialIsOpen": false + }, + { + "id": "def-server.indexPatterns", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.indexPatterns.isFilterable", + "type": "Function", + "label": "isFilterable", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L127" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isFilterable", + "text": "isFilterable" + } + ] + }, + { + "tags": [], + "id": "def-server.indexPatterns.isNestedField", + "type": "Function", + "label": "isNestedField", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L128" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isNestedField", + "text": "isNestedField" + } + ] + } + ], + "description": [], + "label": "indexPatterns", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L126" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11" + }, + "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\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AggGroupLabels", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AggGroupLabels.[AggGroupNames.Buckets]", + "type": "string", + "label": "[AggGroupNames.Buckets]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21" + } + }, + { + "tags": [], + "id": "def-server.AggGroupLabels.[AggGroupNames.Metrics]", + "type": "string", + "label": "[AggGroupNames.Metrics]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24" + } + }, + { + "tags": [], + "id": "def-server.AggGroupLabels.[AggGroupNames.None]", + "type": "string", + "label": "[AggGroupNames.None]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27" + } + } + ], + "description": [], + "label": "AggGroupLabels", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12" + }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.search", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-server.search.aggs", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.search.aggs.CidrMask", + "type": "Object", + "label": "CidrMask", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L243" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.dateHistogramInterval", + "type": "Function", + "label": "dateHistogramInterval", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L244" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.dateHistogramInterval", + "text": "dateHistogramInterval" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.intervalOptions", + "type": "Array", + "label": "intervalOptions", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L245" + }, + "signature": [ + "({ display: string; val: string; enabled(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.InvalidEsCalendarIntervalError", + "type": "Object", + "label": "InvalidEsCalendarIntervalError", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L246" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.InvalidEsIntervalFormatError", + "type": "Object", + "label": "InvalidEsIntervalFormatError", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L247" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.Ipv4Address", + "type": "Object", + "label": "Ipv4Address", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L248" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.Ipv4Address", + "text": "Ipv4Address" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.isNumberType", + "type": "Function", + "label": "isNumberType", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 249, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L249" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.isStringType", + "type": "Function", + "label": "isStringType", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L250" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.isType", + "type": "Function", + "label": "isType", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L251" + }, + "signature": [ + "(...types: string[]) => (agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.isValidEsInterval", + "type": "Function", + "label": "isValidEsInterval", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L252" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidEsInterval", + "text": "isValidEsInterval" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.isValidInterval", + "type": "Function", + "label": "isValidInterval", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L253" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.isValidInterval", + "text": "isValidInterval" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.parentPipelineType", + "type": "string", + "label": "parentPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L254" + } + }, + { + "tags": [], + "id": "def-server.search.aggs.parseEsInterval", + "type": "Function", + "label": "parseEsInterval", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L255" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseEsInterval", + "text": "parseEsInterval" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.parseInterval", + "type": "Function", + "label": "parseInterval", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L256" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.parseInterval", + "text": "parseInterval" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.propFilter", + "type": "Function", + "label": "propFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L257" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.propFilter", + "text": "propFilter" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.siblingPipelineType", + "type": "string", + "label": "siblingPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 258, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L258" + } + }, + { + "tags": [], + "id": "def-server.search.aggs.termsAggFilter", + "type": "Array", + "label": "termsAggFilter", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L259" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.toAbsoluteDates", + "type": "Function", + "label": "toAbsoluteDates", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L260" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.toAbsoluteDates", + "text": "toAbsoluteDates" + } + ] + }, + { + "tags": [], + "id": "def-server.search.aggs.calcAutoIntervalLessThan", + "type": "Function", + "label": "calcAutoIntervalLessThan", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L261" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.calcAutoIntervalLessThan", + "text": "calcAutoIntervalLessThan" + } + ] + } + ], + "description": [], + "label": "aggs", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L242" + } + }, + { + "tags": [], + "id": "def-server.search.getRequestInspectorStats", + "type": "Function", + "label": "getRequestInspectorStats", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 263, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L263" + }, + "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": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L264" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.getResponseInspectorStats", + "text": "getResponseInspectorStats" + } + ] + }, + { + "tags": [], + "id": "def-server.search.tabifyAggResponse", + "type": "Function", + "label": "tabifyAggResponse", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 265, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L265" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.tabifyAggResponse", + "text": "tabifyAggResponse" + } + ] + }, + { + "tags": [], + "id": "def-server.search.tabifyGetColumns", + "type": "Function", + "label": "tabifyGetColumns", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L266" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.tabifyGetColumns", + "text": "tabifyGetColumns" + } + ] + } + ], + "description": [], + "label": "search", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L241" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-server.DataPluginSetup", + "type": "Interface", + "label": "DataPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.DataPluginSetup.search", + "type": "Object", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L29" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchSetup", + "text": "ISearchSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.DataPluginSetup.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L30" + }, + "signature": [ + "{ register: (customFieldFormat: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + ") => number; }" + ] + } + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L28" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.DataPluginStart", + "type": "Interface", + "label": "DataPluginStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.DataPluginStart.search", + "type": "Object", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L38" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStart", + "text": "ISearchStart" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.DataPluginStart.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L39" + }, + "signature": [ + "{ fieldFormatServiceFactory: (uiSettings: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ">; }" + ] + }, + { + "tags": [], + "id": "def-server.DataPluginStart.indexPatterns", + "type": "Object", + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L40" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceStart", + "text": "IndexPatternsServiceStart" + } + ] + } + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L37" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "id": "def-common.KQLSyntaxError", + "type": "Class", + "tags": [], + "label": "KQLSyntaxError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KQLSyntaxError", + "text": "KQLSyntaxError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-common.KQLSyntaxError.shortMessage", + "type": "string", + "label": "shortMessage", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L42" + } + }, + { + "id": "def-common.KQLSyntaxError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "KQLSyntaxErrorData" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44" + } + }, + { + "type": "Any", + "label": "expression", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44" + } + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L41" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KbnFieldType", + "type": "Class", + "tags": [], + "label": "KbnFieldType", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.KbnFieldType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldType.sortable", + "type": "boolean", + "label": "sortable", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldType.filterable", + "type": "boolean", + "label": "filterable", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldType.esTypes", + "type": "Object", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L15" + }, + "signature": [ + "readonly ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]" + ] + }, + { + "id": "def-common.KbnFieldType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KbnFieldTypeOptions", + "text": "KbnFieldTypeOptions" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L11" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.buildEsQuery", + "type": "Function", + "label": "buildEsQuery", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, queries: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[], filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L33" + } + }, + { + "type": "CompoundType", + "label": "queries", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[]" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L34" + } + }, + { + "type": "CompoundType", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [ + "- a filter object or array of filter objects" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L35" + } + }, + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L36" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildQueryFromFilters", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L47" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L48" + } + }, + { + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L49" + } + } + ], + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "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": "buildQueryFromFilters", + "source": { + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L46" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.luceneStringToDsl", + "type": "Function", + "label": "luceneStringToDsl", + "signature": [ + "(query: any) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + } + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "query", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.decorateQuery", + "type": "Function", + "label": "decorateQuery", + "signature": [ + "(query: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + }, + ", queryStringOptions: string | Record, dateFormatTZ: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + } + ], + "description": [ + "\nDecorate queries with default parameters" + ], + "children": [ + { + "type": "CompoundType", + "label": "query", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" + } + ], + "description": [ + "object" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "queryStringOptions", + "isRequired": true, + "signature": [ + "string | Record" + ], + "description": [ + "query:queryString:options from UI settings" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L23" + } + }, + { + "type": "string", + "label": "dateFormatTZ", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "dateFormat:tz from UI settings" + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getEsQueryConfig", + "type": "Function", + "label": "getEsQueryConfig", + "signature": [ + "(config: KibanaConfig) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "KibanaConfig" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/get_es_query_config.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/get_es_query_config.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.cleanFilter", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L36" + } + } + ], + "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" + } + ], + "description": [ + "\nClean out any invalid attributes from the filters" + ], + "label": "cleanFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L36" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilterDisabled", + "type": "Function", + "children": [ + { + "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": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L38" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => boolean" + ], + "description": [], + "label": "isFilterDisabled", + "source": { + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L38" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildFilter", + "type": "Function", + "label": "buildFilter", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FILTERS", + "text": "FILTERS" + }, + ", negate: boolean, disabled: boolean, params: any, alias: string | null, store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L22" + } + }, + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L23" + } + }, + { + "type": "Enum", + "label": "type", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FILTERS", + "text": "FILTERS" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L24" + } + }, + { + "type": "boolean", + "label": "negate", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L25" + } + }, + { + "type": "boolean", + "label": "disabled", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L26" + } + }, + { + "type": "Any", + "label": "params", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L27" + } + }, + { + "type": "CompoundType", + "label": "alias", + "isRequired": false, + "signature": [ + "string | null" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L28" + } + }, + { + "type": "Enum", + "label": "store", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildCustomFilter", + "type": "Function", + "label": "buildCustomFilter", + "signature": [ + "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "children": [ + { + "type": "string", + "label": "indexPatternString", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L40" + } + }, + { + "type": "Any", + "label": "queryDsl", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L41" + } + }, + { + "type": "boolean", + "label": "disabled", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L42" + } + }, + { + "type": "boolean", + "label": "negate", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L43" + } + }, + { + "type": "CompoundType", + "label": "alias", + "isRequired": false, + "signature": [ + "string | null" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L44" + } + }, + { + "type": "Enum", + "label": "store", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isExistsFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L23" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } + ], + "description": [], + "label": "isExistsFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L23" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getExistsFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L25" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildExistsFilter", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29" + } + } + ], + "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" + } + ], + "description": [], + "label": "buildExistsFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isGeoBoundingBoxFilter", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L23" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" + } + ], + "description": [], + "label": "isGeoBoundingBoxFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L23" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoBoundingBoxFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L26" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" + }, + ") => any" + ], + "description": [], + "label": "getGeoBoundingBoxFilterField", + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isGeoPolygonFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L22" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" + } + ], + "description": [], + "label": "isGeoPolygonFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoPolygonFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L25" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getDisplayValueFromFilter", + "type": "Function", + "label": "getDisplayValueFromFilter", + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ", indexPatterns: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]) => string" + ], + "description": [], + "children": [ + { + "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/get_display_value.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31" + } + }, + { + "type": "Array", + "label": "indexPatterns", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getFilterField", + "type": "Function", + "children": [ + { + "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/get_filter_field.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_field.ts#L18" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_field.ts#L18" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getFilterParams", + "type": "Function", + "label": "getFilterParams", + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => any" + ], + "description": [], + "children": [ + { + "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/get_filter_params.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_params.ts#L11" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_params.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getIndexPatternFromFilter", + "type": "Function", + "label": "getIndexPatternFromFilter", + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ", indexPatterns: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "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/get_index_pattern_from_filter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L13" + } + }, + { + "type": "Array", + "label": "indexPatterns", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isMatchAllFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L21" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilter", + "text": "MatchAllFilter" + } + ], + "description": [], + "label": "isMatchAllFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L21" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildEmptyFilter", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "isPinned", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52" + } + }, + { + "type": "string", + "label": "index", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52" + } + } + ], + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "label": "buildEmptyFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilterPinned", + "type": "Function", + "children": [ + { + "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": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L66" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L66" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.toggleFilterDisabled", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L70" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => { meta: { disabled: boolean; alias: string | null; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; query?: any; }" + ], + "description": [], + "label": "toggleFilterDisabled", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L70" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.toggleFilterNegated", + "type": "Function", + "children": [ + { + "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": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L77" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterState", + "text": "FilterState" + }, + " | undefined; query?: any; }" + ], + "description": [], + "label": "toggleFilterNegated", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L77" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.toggleFilterPinned", + "type": "Function", + "children": [ + { + "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": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L84" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => { $state: { store: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + "; }; meta: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + }, + "; query?: any; }" + ], + "description": [], + "label": "toggleFilterPinned", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L84" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.enableFilter", + "type": "Function", + "children": [ + { + "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": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L91" + } + } + ], + "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" + } + ], + "description": [], + "label": "enableFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L91" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.disableFilter", + "type": "Function", + "children": [ + { + "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": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L94" + } + } + ], + "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" + } + ], + "description": [], + "label": "disableFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L94" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.pinFilter", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L97" + } + } + ], + "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" + } + ], + "description": [], + "label": "pinFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L97" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.unpinFilter", + "type": "Function", + "children": [ + { + "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": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L100" + } + } + ], + "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" + } + ], + "description": [], + "label": "unpinFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L100" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilter", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "label": "isFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilters", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isMissingFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L18" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + } + ], + "description": [], + "label": "isMissingFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L18" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMissingFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L20" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MissingFilter", + "text": "MissingFilter" + }, + ") => any" + ], + "description": [], + "label": "getMissingFilterField", + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isPhraseFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L34" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ], + "description": [], + "label": "isPhraseFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L34" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isScriptedPhraseFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L46" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ], + "description": [], + "label": "isScriptedPhraseFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L46" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPhraseFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L49" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + }, + ") => string" + ], + "description": [], + "label": "getPhraseFilterField", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L49" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPhraseFilterValue", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L54" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + }, + ") => PhraseFilterValue" + ], + "description": [], + "label": "getPhraseFilterValue", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L54" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildPhraseFilter", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L61" + } + }, + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L62" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L63" + } + } + ], + "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" + } + ], + "description": [], + "label": "buildPhraseFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L60" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPhraseScript", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84" + } + }, + { + "type": "string", + "label": "value", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84" + } + } + ], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }" + ], + "description": [], + "label": "getPhraseScript", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getConvertedValueForField", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102" + } + }, + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102" + } + } + ], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", value: any) => any" + ], + "description": [], + "label": "getConvertedValueForField", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildInlineScriptForPhraseFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "scriptedField", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L123" + } + } + ], + "signature": [ + "(scriptedField: any) => string" + ], + "description": [ + "\nTakes a scripted field and returns an inline script appropriate for use in a script query.\nHandles lucene expression and Painless scripts. Other langs aren't guaranteed to generate valid\nscripts.\n" + ], + "label": "buildInlineScriptForPhraseFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L123" + }, + "tags": [], + "returnComment": [ + "The inline script string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.isPhrasesFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L23" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ], + "description": [], + "label": "isPhrasesFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L23" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPhrasesFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L26" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + }, + ") => string | undefined" + ], + "description": [], + "label": "getPhrasesFilterField", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildPhrasesFilter", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L35" + } + }, + { + "type": "Array", + "label": "params", + "isRequired": true, + "signature": [ + "any[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L36" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L37" + } + } + ], + "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" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + } + ], + "description": [], + "label": "buildPhrasesFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L34" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isQueryStringFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L22" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" + } + ], + "description": [], + "label": "isQueryStringFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildQueryFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "query", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26" + } + }, + { + "type": "string", + "label": "index", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26" + } + }, + { + "type": "string", + "label": "alias", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26" + } + } + ], + "signature": [ + "(query: any, index: string, alias: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.QueryStringFilter", + "text": "QueryStringFilter" + } + ], + "description": [], + "label": "buildQueryFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isRangeFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L73" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } + ], + "description": [], + "label": "isRangeFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L73" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isScriptedRangeFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L75" + } + } + ], + "signature": [ + "(filter: any) => filter is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } + ], + "description": [], + "label": "isScriptedRangeFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L75" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getRangeFilterField", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "filter", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L81" + } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + ") => string" + ], + "description": [], + "label": "getRangeFilterField", + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L81" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildRangeFilter", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L94" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L95" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L96" + } + }, + { + "type": "string", + "label": "formattedValue", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L97" + } + } + ], + "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" + } + ], + "description": [], + "label": "buildRangeFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L93" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getRangeScript", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140" + } + } + ], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", params: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ") => { script: { source: string; params: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ">; lang: string | undefined; }; }" + ], + "description": [], + "label": "getRangeScript", + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.fromLiteralExpression", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "expression", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L31" + } + }, + { + "type": "Object", + "label": "parseOptions", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L32" + } + } + ], + "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" + } + ], + "description": [], + "label": "fromLiteralExpression", + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.fromKueryExpression", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "expression", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L45" + } + }, + { + "type": "Object", + "label": "parseOptions", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L46" + } + } + ], + "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" + } + ], + "description": [], + "label": "fromKueryExpression", + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L44" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.doesKueryExpressionHaveLuceneSyntaxError", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "expression", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L60" + } + } + ], + "signature": [ + "(expression: any) => boolean" + ], + "description": [], + "label": "doesKueryExpressionHaveLuceneSyntaxError", + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L59" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.toElasticsearchQuery", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "node", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L78" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L79" + } + }, + { + "type": "Object", + "label": "config", + "isRequired": false, + "signature": [ + "Record | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L80" + } + }, + { + "type": "Object", + "label": "context", + "isRequired": false, + "signature": [ + "Record | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L81" + } + } + ], + "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" + } + ], + "description": [], + "label": "toElasticsearchQuery", + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L77" + }, + "tags": [ + "params", + "params" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.castEsToKbnFieldTypeName", + "type": "Function", + "children": [ + { + "type": "string", + "label": "esType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + } + } + ], + "signature": [ + "(esType: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getKbnFieldType", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L22" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KbnFieldType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L22" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getKbnTypeNames", + "type": "Function", + "children": [], + "signature": [ + "() => string[]" + ], + "description": [ + "\n Get the esTypes known by all kbnFieldTypes\n" + ], + "label": "getKbnTypeNames", + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L30" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getFilterableKbnTypeNames", + "type": "Function", + "children": [], + "signature": [ + "() => string[]" + ], + "description": [ + "\n Get filterable KbnFieldTypes\n" + ], + "label": "getFilterableKbnTypeNames", + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L50" + }, + "tags": [ + "return" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.shortenDottedString", + "type": "Function", + "label": "shortenDottedString", + "signature": [ + "(input: any) => any" + ], + "description": [ + "\nConvert a dot.notated.string into a short\nversion (d.n.string)\n" + ], + "children": [ + { + "type": "Any", + "label": "input", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/utils/shorten_dotted_string.ts#L17" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/utils/shorten_dotted_string.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.datatableToCSV", + "type": "Function", + "label": "datatableToCSV", + "signature": [ + "({ columns, rows }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ columns, rows }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L42" + } + }, + { + "type": "Object", + "label": "{ csvSeparator, quoteValues, formatFactory, raw }", + "isRequired": true, + "signature": [ + "CSVOptions" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L43" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L41" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.EsQueryConfig", + "type": "Interface", + "label": "EsQueryConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EsQueryConfig.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.EsQueryConfig.queryStringOptions", + "type": "Object", + "label": "queryStringOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.EsQueryConfig.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.EsQueryConfig.dateFormatTZ", + "type": "string", + "label": "dateFormatTZ", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FilterExistsProperty", + "type": "Interface", + "label": "FilterExistsProperty", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FilterExistsProperty.field", + "type": "Any", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L15" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MatchAllFilterMeta", + "type": "Interface", + "label": "MatchAllFilterMeta", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilterMeta", + "text": "MatchAllFilterMeta" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterMeta", + "text": "FilterMeta" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MatchAllFilterMeta.field", + "type": "Any", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L12" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.MatchAllFilterMeta.formattedValue", + "type": "string", + "label": "formattedValue", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FilterValueFormatter", + "type": "Interface", + "label": "FilterValueFormatter", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FilterValueFormatter.convert", + "type": "Function", + "label": "convert", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L21" + }, + "signature": [ + "FilterFormatterFunction" + ] + }, + { + "tags": [], + "id": "def-common.FilterValueFormatter.getConverterFor", + "type": "Function", + "label": "getConverterFor", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L22" + }, + "signature": [ + "(type: string) => FilterFormatterFunction" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.LatLon", + "type": "Interface", + "label": "LatLon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.LatLon.lat", + "type": "number", + "label": "lat", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L48" + } + }, + { + "tags": [], + "id": "def-common.LatLon.lon", + "type": "number", + "label": "lon", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L49" + } + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RangeFilterParams", + "type": "Interface", + "label": "RangeFilterParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RangeFilterParams.from", + "type": "CompoundType", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L36" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.to", + "type": "CompoundType", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L37" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.gt", + "type": "CompoundType", + "label": "gt", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L38" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.lt", + "type": "CompoundType", + "label": "lt", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L39" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.gte", + "type": "CompoundType", + "label": "gte", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L40" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.lte", + "type": "CompoundType", + "label": "lte", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L41" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.format", + "type": "string", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L42" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.EsRangeFilter", + "type": "Interface", + "label": "EsRangeFilter", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EsRangeFilter.range", + "type": "Object", + "label": "range", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L57" + }, + "signature": [ + "{ [key: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + "; }" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KueryNode", + "type": "Interface", + "label": "KueryNode", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.KueryNode.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12" + }, + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ] + }, + { + "id": "def-common.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KueryParseOptions", + "type": "Interface", + "label": "KueryParseOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.KueryParseOptions.helpers", + "type": "Object", + "label": "helpers", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L19" + }, + "signature": [ + "{ [key: string]: any; }" + ] + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.startRule", + "type": "string", + "label": "startRule", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L23" + } + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.errorOnLuceneSyntax", + "type": "boolean", + "label": "errorOnLuceneSyntax", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L24" + } + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.cursorSymbol", + "type": "string", + "label": "cursorSymbol", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L25" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.parseCursor", + "type": "CompoundType", + "label": "parseCursor", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObject", + "type": "Interface", + "label": "SavedObject", + "signature": [ + "SavedObject", + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObject.id", + "type": "string", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" + } + }, + { + "tags": [], + "id": "def-common.SavedObject.type", + "type": "string", + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" + } + }, + { + "tags": [], + "id": "def-common.SavedObject.version", + "type": "string", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.updated_at", + "type": "string", + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.references", + "type": "Array", + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObject.originId", + "type": "string", + "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." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KbnFieldTypeOptions", + "type": "Interface", + "label": "KbnFieldTypeOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.sortable", + "type": "boolean", + "label": "sortable", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.filterable", + "type": "boolean", + "label": "filterable", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L14" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]" + ] + } + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L10" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.FilterStateStore", + "type": "Enum", + "label": "FilterStateStore", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FILTERS", + "type": "Enum", + "label": "FILTERS", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/types.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ES_FIELD_TYPES", + "type": "Enum", + "label": "ES_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KBN_FIELD_TYPES", + "type": "Enum", + "label": "KBN_FIELD_TYPES", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-common.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L9" + }, + "signature": [ + "\"kuery\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CustomFilter", + "type": "Type", + "label": "CustomFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/custom_filter.ts#L11" + }, + "signature": [ + "Filter & { query: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExistsFilterMeta", + "type": "Type", + "label": "ExistsFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L12" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExistsFilter", + "type": "Type", + "label": "ExistsFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L18" + }, + "signature": [ + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GeoBoundingBoxFilterMeta", + "type": "Type", + "label": "GeoBoundingBoxFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L11" + }, + "signature": [ + "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GeoBoundingBoxFilter", + "type": "Type", + "label": "GeoBoundingBoxFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L18" + }, + "signature": [ + "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GeoPolygonFilterMeta", + "type": "Type", + "label": "GeoPolygonFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L11" + }, + "signature": [ + "FilterMeta & { params: { points: LatLon[];}; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GeoPolygonFilter", + "type": "Type", + "label": "GeoPolygonFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L17" + }, + "signature": [ + "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.MatchAllFilter", + "type": "Type", + "label": "MatchAllFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L16" + }, + "signature": [ + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FilterState", + "type": "Type", + "label": "FilterState", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L15" + }, + "signature": [ + "{ store: FilterStateStore; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FilterMeta", + "type": "Type", + "label": "FilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L26" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Filter", + "type": "Type", + "label": "Filter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41" + }, + "signature": [ + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.MissingFilterMeta", + "type": "Type", + "label": "MissingFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L11" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.MissingFilter", + "type": "Type", + "label": "MissingFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L13" + }, + "signature": [ + "Filter & { meta: MissingFilterMeta; missing: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PhraseFilterMeta", + "type": "Type", + "label": "PhraseFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L13" + }, + "signature": [ + "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PhraseFilter", + "type": "Type", + "label": "PhraseFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L21" + }, + "signature": [ + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PhrasesFilterMeta", + "type": "Type", + "label": "PhrasesFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L14" + }, + "signature": [ + "FilterMeta & { params: string[]; field?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PhrasesFilter", + "type": "Type", + "label": "PhrasesFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L19" + }, + "signature": [ + "Filter & { meta: PhrasesFilterMeta; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.QueryStringFilterMeta", + "type": "Type", + "label": "QueryStringFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L11" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.QueryStringFilter", + "type": "Type", + "label": "QueryStringFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L13" + }, + "signature": [ + "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RangeFilterMeta", + "type": "Type", + "label": "RangeFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L50" + }, + "signature": [ + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RangeFilter", + "type": "Type", + "label": "RangeFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L60" + }, + "signature": [ + "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFilter", + "type": "Type", + "label": "FieldFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/types.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.MatchAllFilter", + "text": "MatchAllFilter" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.DslQuery", + "type": "Type", + "label": "DslQuery", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L16" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GetConfigFn", + "type": "Type", + "label": "GetConfigFn", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/types.ts#L23" + }, + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L17" + }, + "signature": [ + "\"text/plain;charset=utf-8\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11" + }, + "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\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.nodeTypes", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.nodeTypes.function", + "type": "Object", + "label": "function", + "description": [ + "// This requires better typing of the different typings and their return types.\n// @ts-ignore" + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L21" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/function" + } + ] + }, + { + "tags": [], + "id": "def-common.nodeTypes.literal", + "type": "Object", + "label": "literal", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L22" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/literal" + } + ] + }, + { + "tags": [], + "id": "def-common.nodeTypes.namedArg", + "type": "Object", + "label": "namedArg", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L23" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/named_arg" + } + ] + }, + { + "tags": [], + "id": "def-common.nodeTypes.wildcard", + "type": "Object", + "label": "wildcard", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L24" + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/wildcard" + } + ] + } + ], + "description": [], + "label": "nodeTypes", + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/index.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.nodeBuilder", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.nodeBuilder.is", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12" + } + }, + { + "type": "CompoundType", + "label": "value", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12" + } + } + ], + "signature": [ + "(fieldName: string, value: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FunctionTypeBuildNode", + "text": "FunctionTypeBuildNode" + } + ], + "description": [], + "label": "is", + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.nodeBuilder.or", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "nodes", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L19" + } + } + ], + "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" + } + ], + "description": [], + "label": "or", + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L19" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.nodeBuilder.and", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "nodes", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L22" + } + } + ], + "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" + } + ], + "description": [], + "label": "and", + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L22" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "nodeBuilder", + "source": { + "path": "src/plugins/data/common/es_query/kuery/node_types/node_builder.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L11" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/data.mdx b/api_docs/data.mdx new file mode 100644 index 0000000000000..f585b23a16a0c --- /dev/null +++ b/api_docs/data.mdx @@ -0,0 +1,85 @@ +--- +id: kibDataPluginApi +slug: /kibana-dev-docs/dataPluginApi +title: data +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dataObj from './data.json'; + +## Client + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json new file mode 100644 index 0000000000000..6d78369b25d1f --- /dev/null +++ b/api_docs/data_autocomplete.json @@ -0,0 +1,438 @@ +{ + "id": "data.autocomplete", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.QuerySuggestionGetFnArgs", + "type": "Interface", + "label": "QuerySuggestionGetFnArgs", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.language", + "type": "string", + "label": "language", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L25" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.indexPatterns", + "type": "Array", + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L26" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.query", + "type": "string", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.selectionStart", + "type": "number", + "label": "selectionStart", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.selectionEnd", + "type": "number", + "label": "selectionEnd", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L29" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.signal", + "type": "Object", + "label": "signal", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L30" + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.useTimeRange", + "type": "CompoundType", + "label": "useTimeRange", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L31" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.boolFilter", + "type": "Any", + "label": "boolFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L32" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.QuerySuggestionBasic", + "type": "Interface", + "label": "QuerySuggestionBasic", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.type", + "type": "Enum", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L37" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionTypes", + "text": "QuerySuggestionTypes" + } + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.description", + "type": "CompoundType", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L38" + }, + "signature": [ + "string | JSX.Element | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.end", + "type": "number", + "label": "end", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L39" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.start", + "type": "number", + "label": "start", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L40" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L41" + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionBasic.cursorIndex", + "type": "number", + "label": "cursorIndex", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L42" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-public.QuerySuggestionField", + "type": "Interface", + "label": "QuerySuggestionField", + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionField", + "text": "QuerySuggestionField" + }, + " extends ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionBasic", + "text": "QuerySuggestionBasic" + } + ], + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.QuerySuggestionField.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L47" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionTypes", + "text": "QuerySuggestionTypes" + }, + ".Field" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionField.field", + "type": "Object", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L48" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ] + } + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L46" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.QuerySuggestionTypes", + "type": "Enum", + "label": "QuerySuggestionTypes", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L11" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.QuerySuggestion", + "type": "Type", + "label": "QuerySuggestion", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionBasic", + "text": "QuerySuggestionBasic" + }, + " | ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionField", + "text": "QuerySuggestionField" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.QuerySuggestionGetFn", + "type": "Type", + "label": "QuerySuggestionGetFn", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L19" + }, + "signature": [ + "(args: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFnArgs", + "text": "QuerySuggestionGetFnArgs" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataAutocompletePluginApi", + "section": "def-public.QuerySuggestion", + "text": "QuerySuggestion" + }, + "[]> | undefined" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AutocompleteStart", + "type": "Type", + "label": "AutocompleteStart", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/autocomplete_service.ts#L93" + }, + "signature": [ + "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/data_autocomplete.mdx b/api_docs/data_autocomplete.mdx new file mode 100644 index 0000000000000..c2231648ac905 --- /dev/null +++ b/api_docs/data_autocomplete.mdx @@ -0,0 +1,24 @@ +--- +id: kibDataAutocompletePluginApi +slug: /kibana-dev-docs/data.autocompletePluginApi +title: data.autocomplete +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.autocomplete plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.autocomplete'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dataAutocompleteObj from './data_autocomplete.json'; + +## Client + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json new file mode 100644 index 0000000000000..02c69f4a68fc5 --- /dev/null +++ b/api_docs/data_enhanced.json @@ -0,0 +1,980 @@ +{ + "id": "dataEnhanced", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17" + }, + "signature": [ + "\"ese\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.EQL_SEARCH_STRATEGY", + "type": "string", + "label": "EQL_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19" + }, + "signature": [ + "\"eql\"" + ], + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "id": "def-public.DataEnhancedStart", + "type": "Type", + "label": "DataEnhancedStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/public/plugin.ts#L40" + }, + "signature": [ + "void" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "id": "def-server.EnhancedDataServerPlugin", + "type": "Class", + "tags": [], + "label": "EnhancedDataServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "dataEnhanced", + "scope": "server", + "docId": "kibDataEnhancedPluginApi", + "section": "def-server.EnhancedDataServerPlugin", + "text": "EnhancedDataServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "" + ], + "children": [ + { + "id": "def-server.EnhancedDataServerPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; pageSize: number; trackingInterval: 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": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48" + } + }, + { + "id": "def-server.EnhancedDataServerPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ", unknown>, deps: SetupDependencies) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ", unknown>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53" + } + }, + { + "type": "Object", + "label": "deps", + "isRequired": true, + "signature": [ + "SetupDependencies" + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53" + } + }, + { + "id": "def-server.EnhancedDataServerPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", { taskManager }: ", + { + "pluginId": "dataEnhanced", + "scope": "server", + "docId": "kibDataEnhancedPluginApi", + "section": "def-server.StartDependencies", + "text": "StartDependencies" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95" + } + }, + { + "type": "Object", + "label": "{ taskManager }", + "isRequired": true, + "signature": [ + { + "pluginId": "dataEnhanced", + "scope": "server", + "docId": "kibDataEnhancedPluginApi", + "section": "def-server.StartDependencies", + "text": "StartDependencies" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95" + } + }, + { + "id": "def-server.EnhancedDataServerPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L101" + } + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/server/plugin.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L42" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-server.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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17" + }, + "signature": [ + "\"ese\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.EQL_SEARCH_STRATEGY", + "type": "string", + "label": "EQL_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19" + }, + "signature": [ + "\"eql\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.pollSearch", + "type": "Function", + "children": [ + { + "type": "Function", + "label": "search", + "isRequired": true, + "signature": [ + "() => Promise" + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L16" + } + }, + { + "type": "Function", + "label": "cancel", + "isRequired": false, + "signature": [ + "(() => void) | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L17" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L18" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L15" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L24" + }, + "signature": [ + "TransportRequestOptions", + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L23" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L33" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L29" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.name", + "type": "string", + "label": "name", + "description": [ + "\nUser-facing session name to be displayed in session management" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L16" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.appId", + "type": "string", + "label": "appId", + "description": [ + "\nApp that created the session. e.g 'discover'" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.created", + "type": "string", + "label": "created", + "description": [ + "\nCreation time of the session" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L24" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.touched", + "type": "string", + "label": "touched", + "description": [ + "\nLast touch time of the session" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L28" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.expires", + "type": "string", + "label": "expires", + "description": [ + "\nExpiration time of the session. Expiration itself is managed by Elasticsearch." + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L32" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.status", + "type": "Enum", + "label": "status", + "description": [ + "\nstatus" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L36" + }, + "signature": [ + { + "pluginId": "dataEnhanced", + "scope": "common", + "docId": "kibDataEnhancedPluginApi", + "section": "def-common.SearchSessionStatus", + "text": "SearchSessionStatus" + } + ] + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId", + "type": "string", + "label": "urlGeneratorId", + "description": [ + "\nurlGeneratorId" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L40" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L45" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L50" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L54" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L59" + } + }, + { + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.realmName", + "type": "string", + "label": "realmName", + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L64" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSessionSavedObjectAttributes.username", + "type": "string", + "label": "username", + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L65" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L11" + }, + "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": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L72" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionRequestInfo.strategy", + "type": "string", + "label": "strategy", + "description": [ + "\nSearch strategy used to submit the search request" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L76" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionRequestInfo.status", + "type": "string", + "label": "status", + "description": [ + "\nstatus" + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L80" + } + }, + { + "tags": [], + "id": "def-common.SearchSessionRequestInfo.error", + "type": "string", + "label": "error", + "description": [ + "\nAn optional error. Set if status is set to error." + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L84" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L68" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.SearchSessionStatus", + "type": "Enum", + "label": "SearchSessionStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/status.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/status.ts#L8" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-common.SEARCH_SESSION_TYPE", + "type": "string", + "label": "SEARCH_SESSION_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L10" + }, + "signature": [ + "\"search-session\"" + ], + "initialIsOpen": false + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L21" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L27" + }, + "signature": [ + "IKibanaSearchResponse>" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx new file mode 100644 index 0000000000000..fc3b5ad770277 --- /dev/null +++ b/api_docs/data_enhanced.mdx @@ -0,0 +1,43 @@ +--- +id: kibDataEnhancedPluginApi +slug: /kibana-dev-docs/dataEnhancedPluginApi +title: dataEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dataEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced'] +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 dataEnhancedObj from './data_enhanced.json'; + +## Client + +### Start + + +### Consts, variables and types + + +## Server + +### Classes + + +### Consts, variables and types + + +## Common + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json new file mode 100644 index 0000000000000..f1bd701515604 --- /dev/null +++ b/api_docs/data_field_formats.json @@ -0,0 +1,4136 @@ +{ + "id": "data.fieldFormats", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.baseFormattersPublic", + "type": "Array", + "label": "baseFormattersPublic", + "description": [], + "source": { + "path": "src/plugins/data/public/field_formats/constants.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/field_formats/constants.ts#L12" + }, + "signature": [ + "(typeof ", + "DateFormat", + " | typeof ", + "DateNanosFormat", + " | ", + "FieldFormatInstanceType", + ")[]" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatsStart", + "type": "Type", + "label": "FieldFormatsStart", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/field_formats/field_formats_service.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/field_formats/field_formats_service.ts#L55" + }, + "signature": [ + "Pick & { deserialize: FormatFactory; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "id": "def-common.FieldFormatsRegistry", + "type": "Class", + "tags": [], + "label": "FieldFormatsRegistry", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldFormatsRegistry.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L29" + }, + "signature": [ + "Map" + ] + }, + { + "id": "def-common.FieldFormatsRegistry.defaultMap", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "defaultMap", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L30" + } + }, + { + "id": "def-common.FieldFormatsRegistry.metaParamsOptions", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "metaParamsOptions", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.FieldFormatsRegistry.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L32" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | undefined" + ] + }, + { + "id": "def-common.FieldFormatsRegistry.deserialize", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L34" + } + } + ], + "signature": [ + "(mapping?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "description": [], + "label": "deserialize", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L34" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.init", + "type": "Function", + "label": "init", + "signature": [ + "(getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]) => void" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getConfig", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L52" + } + }, + { + "type": "Object", + "label": "metaParamsOptions", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L53" + } + }, + { + "type": "Array", + "label": "defaultFieldConverters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L54" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L51" + } + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultConfig", + "type": "Function", + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L72" + } + }, + { + "type": "Array", + "label": "esTypes", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L73" + } + } + ], + "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" + } + ], + "description": [ + "\nGet the id of the default type for this field type\nusing the format:defaultTypeMap config map\n" + ], + "label": "getDefaultConfig", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L71" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getType", + "type": "Function", + "children": [ + { + "type": "string", + "label": "formatId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L88" + } + } + ], + "signature": [ + "(formatId: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L88" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams", + "type": "Function", + "children": [ + { + "type": "string", + "label": "formatId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L102" + } + } + ], + "signature": [ + "(formatId: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined" + ], + "description": [], + "label": "getTypeWithoutMetaParams", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L102" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultType", + "type": "Function", + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L116" + } + }, + { + "type": "Array", + "label": "esTypes", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L117" + } + } + ], + "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.FieldFormatInstanceType", + "text": "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L115" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "esTypes", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L131" + } + } + ], + "signature": [ + "(esTypes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined) => ", + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L131" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultTypeName", + "type": "Function", + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 148, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L148" + } + }, + { + "type": "Array", + "label": "esTypes", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 149, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L149" + } + } + ], + "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": "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" + } + ], + "description": [ + "\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n" + ], + "label": "getDefaultTypeName", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L147" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "tags": [ + "return" + ], + "id": "def-common.FieldFormatsRegistry.getInstance", + "type": "Function", + "label": "getInstance", + "description": [ + "\nGet the singleton instance of the FieldFormat type by its id.\n" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L162" + }, + "signature": [ + "((formatId: string, params?: Record) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") & _.MemoizedFunction" + ] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain", + "type": "Function", + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L187" + } + }, + { + "type": "Array", + "label": "esTypes", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L188" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L189" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L186" + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver", + "type": "Function", + "label": "getDefaultInstanceCacheResolver", + "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" + }, + "[]) => 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" + ], + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210" + } + }, + { + "type": "Array", + "label": "esTypes", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210" + } + }, + { + "id": "def-common.FieldFormatsRegistry.getByFieldType", + "type": "Function", + "label": "getByFieldType", + "signature": [ + "(fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]" + ], + "description": [ + "\nGet filtered list of field formats by format type\n" + ], + "children": [ + { + "type": "Enum", + "label": "fieldType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L223" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L223" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L242" + }, + "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" + }, + ") & _.MemoizedFunction" + ] + }, + { + "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap", + "type": "Function", + "label": "parseDefaultTypeMap", + "signature": [ + "(value: any) => void" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L244" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L244" + } + }, + { + "id": "def-common.FieldFormatsRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(fieldFormats: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]) => void" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "fieldFormats", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L255" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L255" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormat", + "type": "Class", + "tags": [], + "label": "FieldFormat", + "description": [], + "children": [ + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-common.FieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L32" + } + }, + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-common.FieldFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L38" + } + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-common.FieldFormat.fieldType", + "type": "CompoundType", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L44" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-common.FieldFormat.convertObject", + "type": "Object", + "label": "convertObject", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-common.FieldFormat.htmlConvert", + "type": "Function", + "label": "htmlConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L60" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeConvert", + "text": "HtmlContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-common.FieldFormat.textConvert", + "type": "Function", + "label": "textConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L68" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TextContextTypeConvert", + "text": "TextContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-common.FieldFormat.type", + "type": "Any", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L74" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormat.allowsNumericalAggregations", + "type": "CompoundType", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L75" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormat._params", + "type": "Any", + "label": "_params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L77" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormat.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L78" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | undefined" + ] + }, + { + "id": "def-common.FieldFormat.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "_params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IFieldFormatMetaParams", + "text": "IFieldFormatMetaParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + }, + { + "type": "Function", + "label": "getConfig", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + } + }, + { + "id": "def-common.FieldFormat.convert", + "type": "Function", + "label": "convert", + "signature": [ + "(value: any, contentType?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + }, + ", options?: Record | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined) => string" + ], + "description": [ + "\nConvert a raw value to a formatted string" + ], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L99" + } + }, + { + "type": "CompoundType", + "label": "contentType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L100" + } + }, + { + "type": "CompoundType", + "label": "options", + "isRequired": false, + "signature": [ + "Record | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L101" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L98" + } + }, + { + "id": "def-common.FieldFormat.getConverterFor", + "type": "Function", + "label": "getConverterFor", + "signature": [ + "(contentType?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" + } + ], + "description": [ + "\nGet a convert function that is bound to a specific contentType" + ], + "children": [ + { + "type": "CompoundType", + "label": "contentType", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L119" + } + } + ], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- a bound converter function" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L118" + } + }, + { + "id": "def-common.FieldFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => Record" + ], + "description": [ + "\nGet parameter defaults" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- parameter defaults" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L133" + } + }, + { + "id": "def-common.FieldFormat.param", + "type": "Function", + "label": "param", + "signature": [ + "(name: string) => any" + ], + "description": [ + "\nGet the value of a param. This value may be a default value.\n" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- the param name to fetch" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144" + } + } + ], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144" + } + }, + { + "id": "def-common.FieldFormat.params", + "type": "Function", + "label": "params", + "signature": [ + "() => Record" + ], + "description": [ + "\nGet all of the params in a single object" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L161" + } + }, + { + "id": "def-common.FieldFormat.toJSON", + "type": "Function", + "label": "toJSON", + "signature": [ + "() => { id: any; params: any; }" + ], + "description": [ + "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L172" + } + }, + { + "id": "def-common.FieldFormat.from", + "type": "Function", + "label": "from", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".from" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "convertFn", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193" + } + }, + { + "id": "def-common.FieldFormat.setupContentType", + "type": "Function", + "label": "setupContentType", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L197" + } + }, + { + "id": "def-common.FieldFormat.isInstanceOfFieldFormat", + "type": "Function", + "label": "isInstanceOfFieldFormat", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ".isInstanceOfFieldFormat" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "fieldFormat", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BoolFormat", + "type": "Class", + "tags": [], + "label": "BoolFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BoolFormat", + "text": "BoolFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.BoolFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L16" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.BoolFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.BoolFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" + ] + }, + { + "id": "def-common.BoolFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L22" + } + } + ], + "signature": [ + "(value: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L22" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BytesFormat", + "type": "Class", + "tags": [], + "label": "BytesFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BytesFormat", + "text": "BytesFormat" + }, + " extends ", + "NumeralFormat" + ], + "children": [ + { + "tags": [], + "id": "def-common.BytesFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L14" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.BytesFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.BytesFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.BytesFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.BytesFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ColorFormat", + "type": "Class", + "tags": [], + "label": "ColorFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.ColorFormat", + "text": "ColorFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.ColorFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.ColorFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.ColorFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L24" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" + ] + }, + { + "id": "def-common.ColorFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "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.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L26" + } + }, + { + "id": "def-common.ColorFormat.findColorRuleForVal", + "type": "Function", + "label": "findColorRuleForVal", + "signature": [ + "(val: any) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L33" + } + }, + { + "id": "def-common.ColorFormat.htmlConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L52" + } + } + ], + "signature": [ + "(val: any) => string" + ], + "description": [], + "label": "htmlConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L52" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DurationFormat", + "type": "Class", + "tags": [], + "label": "DurationFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.DurationFormat", + "text": "DurationFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.DurationFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L158" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L159" + } + }, + { + "tags": [], + "id": "def-common.DurationFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L162" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.inputFormats", + "type": "Array", + "label": "inputFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L163" + }, + "signature": [ + "{ text: string; kind: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.outputFormats", + "type": "Array", + "label": "outputFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L164" + }, + "signature": [ + "{ text: string; method: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L165" + } + }, + { + "id": "def-common.DurationFormat.isHuman", + "type": "Function", + "label": "isHuman", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L167" + } + }, + { + "id": "def-common.DurationFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => { inputFormat: string; outputFormat: string; outputPrecision: number; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L170" + } + }, + { + "id": "def-common.DurationFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L178" + } + } + ], + "signature": [ + "(val: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L178" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L157" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IpFormat", + "type": "Class", + "tags": [], + "label": "IpFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IpFormat", + "text": "IpFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.IpFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L15" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.IpFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.IpFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "id": "def-common.IpFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L21" + } + } + ], + "signature": [ + "(val: any) => any" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L21" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/ip.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NumberFormat", + "type": "Class", + "tags": [], + "label": "NumberFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.NumberFormat", + "text": "NumberFormat" + }, + " extends ", + "NumeralFormat" + ], + "children": [ + { + "tags": [], + "id": "def-common.NumberFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L14" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.NumberFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.NumberFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.NumberFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.NumberFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/number.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PercentFormat", + "type": "Class", + "tags": [], + "label": "PercentFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.PercentFormat", + "text": "PercentFormat" + }, + " extends ", + "NumeralFormat" + ], + "children": [ + { + "tags": [], + "id": "def-common.PercentFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L15" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.PercentFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.PercentFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.PercentFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.PercentFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L22" + } + }, + { + "id": "def-common.PercentFormat.getParamDefaults", + "type": "Function", + "children": [], + "signature": [ + "() => { pattern: any; fractional: boolean; }" + ], + "description": [], + "label": "getParamDefaults", + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L24" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.PercentFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L29" + } + } + ], + "signature": [ + "(val: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L29" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/percent.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RelativeDateFormat", + "type": "Class", + "tags": [], + "label": "RelativeDateFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.RelativeDateFormat", + "text": "RelativeDateFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.RelativeDateFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L16" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.RelativeDateFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.RelativeDateFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "id": "def-common.RelativeDateFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L22" + } + } + ], + "signature": [ + "(val: any) => any" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L22" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/relative_date.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SourceFormat", + "type": "Class", + "tags": [], + "label": "SourceFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.SourceFormat", + "text": "SourceFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.SourceFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L45" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.SourceFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L46" + } + }, + { + "tags": [], + "id": "def-common.SourceFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L47" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "id": "def-common.SourceFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L49" + } + } + ], + "signature": [ + "(value: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L49" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.SourceFormat.htmlConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51" + } + } + ], + "signature": [ + "(value: any, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined) => string" + ], + "description": [], + "label": "htmlConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/source.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.StaticLookupFormat", + "type": "Class", + "tags": [], + "label": "StaticLookupFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StaticLookupFormat", + "text": "StaticLookupFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.StaticLookupFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L25" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.StaticLookupFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L26" + } + }, + { + "tags": [], + "id": "def-common.StaticLookupFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L29" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" + ] + }, + { + "id": "def-common.StaticLookupFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => { lookupEntries: {}[]; unknownKeyValue: null; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L36" + } + }, + { + "id": "def-common.StaticLookupFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L43" + } + } + ], + "signature": [ + "(val: any) => any" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L43" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.UrlFormat", + "type": "Class", + "tags": [], + "label": "UrlFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.UrlFormat", + "text": "UrlFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.UrlFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L47" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.UrlFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L48" + } + }, + { + "tags": [], + "id": "def-common.UrlFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L51" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.UrlFormat.urlTypes", + "type": "Array", + "label": "urlTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L61" + }, + "signature": [ + "{ kind: string; text: string; }[]" + ] + }, + { + "id": "def-common.UrlFormat.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IFieldFormatMetaParams", + "text": "IFieldFormatMetaParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L63" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L63" + } + }, + { + "id": "def-common.UrlFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L68" + } + }, + { + "id": "def-common.UrlFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L131" + } + } + ], + "signature": [ + "(value: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L131" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.UrlFormat.htmlConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "rawValue", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133" + } + } + ], + "signature": [ + "(rawValue: any, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined) => string" + ], + "description": [], + "label": "htmlConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-common.StringFormat", + "type": "Class", + "tags": [], + "label": "StringFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.StringFormat", + "text": "StringFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.StringFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L63" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.StringFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L64" + } + }, + { + "tags": [], + "id": "def-common.StringFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L67" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.StringFormat.transformOptions", + "type": "Array", + "label": "transformOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L80" + }, + "signature": [ + "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" + ] + }, + { + "id": "def-common.StringFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => { transform: boolean; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L82" + } + }, + { + "id": "def-common.StringFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L102" + } + } + ], + "signature": [ + "(val: any) => any" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L102" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/string.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TruncateFormat", + "type": "Class", + "tags": [], + "label": "TruncateFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TruncateFormat", + "text": "TruncateFormat" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.TruncateFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L18" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.TruncateFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L19" + } + }, + { + "tags": [], + "id": "def-common.TruncateFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L22" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "id": "def-common.TruncateFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L24" + } + } + ], + "signature": [ + "(val: any) => any" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L24" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/truncate.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatNotFoundError", + "type": "Class", + "tags": [], + "label": "FieldFormatNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatNotFoundError", + "text": "FieldFormatNotFoundError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-common.FieldFormatNotFoundError.formatId", + "type": "string", + "label": "formatId", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L10" + } + }, + { + "id": "def-common.FieldFormatNotFoundError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11" + } + }, + { + "type": "string", + "label": "formatId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11" + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L9" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.getHighlightRequest", + "type": "Function", + "label": "getHighlightRequest", + "signature": [ + "(query: any, shouldHighlight: boolean) => { pre_tags: string[]; post_tags: string[]; fields: { '*': {}; }; fragment_size: number; } | undefined" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "query", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13" + } + }, + { + "type": "boolean", + "label": "shouldHighlight", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.FieldFormatConfig", + "type": "Interface", + "label": "FieldFormatConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldFormatConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62" + } + }, + { + "tags": [], + "id": "def-common.FieldFormatConfig.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormatConfig.es", + "type": "CompoundType", + "label": "es", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.FIELD_FORMAT_IDS", + "type": "Enum", + "label": "FIELD_FORMAT_IDS", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L42" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-common.IFieldFormatsRegistry", + "type": "Type", + "label": "IFieldFormatsRegistry", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11" + }, + "signature": [ + "{ init: (getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (fieldType: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.baseFormatters", + "type": "Array", + "label": "baseFormatters", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/base_formatters.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/base_formatters.ts#L27" + }, + "signature": [ + "FieldFormatInstanceType", + "[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.HTML_CONTEXT_TYPE", + "type": "CompoundType", + "label": "HTML_CONTEXT_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/content_types/html_content_type.ts#L13" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.TEXT_CONTEXT_TYPE", + "type": "CompoundType", + "label": "TEXT_CONTEXT_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/content_types/text_content_type.ts#L13" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatsGetConfigFn", + "type": "Type", + "label": "FieldFormatsGetConfigFn", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67" + }, + "signature": [ + "(key: string, defaultOverride: T | undefined) => T" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatsContentType", + "type": "Type", + "label": "FieldFormatsContentType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L14" + }, + "signature": [ + "\"html\" | \"text\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatId", + "type": "Type", + "label": "FieldFormatId", + "tags": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L74" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IFieldFormat", + "type": "Type", + "label": "IFieldFormat", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L69" + }, + "signature": [ + "FieldFormat" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatsStartCommon", + "type": "Type", + "label": "FieldFormatsStartCommon", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L96" + }, + "signature": [ + "{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (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) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (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" + } + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-common.DEFAULT_CONVERTER_COLOR", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DEFAULT_CONVERTER_COLOR.range", + "type": "string", + "label": "range", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_CONVERTER_COLOR.regex", + "type": "string", + "label": "regex", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_CONVERTER_COLOR.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_CONVERTER_COLOR.background", + "type": "string", + "label": "background", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L13" + } + } + ], + "description": [], + "label": "DEFAULT_CONVERTER_COLOR", + "source": { + "path": "src/plugins/data/common/field_formats/constants/color_default.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L9" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/data_field_formats.mdx b/api_docs/data_field_formats.mdx new file mode 100644 index 0000000000000..faeba4ac56454 --- /dev/null +++ b/api_docs/data_field_formats.mdx @@ -0,0 +1,38 @@ +--- +id: kibDataFieldFormatsPluginApi +slug: /kibana-dev-docs/data.fieldFormatsPluginApi +title: data.fieldFormats +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.fieldFormats plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.fieldFormats'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dataFieldFormatsObj from './data_field_formats.json'; + +## Client + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json new file mode 100644 index 0000000000000..ab1a9cc2ca8fe --- /dev/null +++ b/api_docs/data_index_patterns.json @@ -0,0 +1,7182 @@ +{ + "id": "data.indexPatterns", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.IndexPatternsFetcher", + "type": "Class", + "tags": [], + "label": "IndexPatternsFetcher", + "description": [], + "children": [ + { + "id": "def-server.IndexPatternsFetcher.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "elasticsearchClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39" + } + }, + { + "type": "boolean", + "label": "allowNoIndices", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39" + } + }, + { + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", + "type": "Function", + "label": "getFieldsForWildcard", + "signature": [ + "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; }) => Promise<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]>" + ], + "description": [ + "\n Get a list of field objects for an index pattern that may contain wildcards\n" + ], + "children": [ + { + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.pattern", + "type": "CompoundType", + "label": "pattern", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L54" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L55" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.fieldCapsOptions", + "type": "Object", + "label": "fieldCapsOptions", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L56" + }, + "signature": [ + "{ allow_no_indices: boolean; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L57" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.rollupIndex", + "type": "string", + "label": "rollupIndex", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L58" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L53" + } + } + ], + "tags": [ + "property", + "property", + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L53" + } + }, + { + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern", + "type": "Function", + "label": "getFieldsForTimePattern", + "signature": [ + "(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]>" + ], + "description": [ + "\n Get a list of field objects for a time pattern\n" + ], + "children": [ + { + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.pattern", + "type": "string", + "label": "pattern", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L116" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L117" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.lookBack", + "type": "number", + "label": "lookBack", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L118" + } + }, + { + "tags": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.interval", + "type": "string", + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L119" + } + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L115" + } + } + ], + "tags": [ + "property", + "property", + "property", + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L115" + } + }, + { + "id": "def-server.IndexPatternsFetcher.validatePatternListActive", + "type": "Function", + "label": "validatePatternListActive", + "signature": [ + "(patternList: string[]) => Promise" + ], + "description": [ + "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + ], + "children": [ + { + "type": "Array", + "label": "patternList", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [ + "string[]" + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L136" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L136" + } + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternsServiceProvider", + "type": "Class", + "tags": [], + "label": "IndexPatternsServiceProvider", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceProvider", + "text": "IndexPatternsServiceProvider" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "" + ], + "children": [ + { + "id": "def-server.IndexPatternsServiceProvider.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStartDependencies", + "text": "DataPluginStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">, { expressions }: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceSetupDeps", + "text": "IndexPatternsServiceSetupDeps" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStartDependencies", + "text": "DataPluginStartDependencies" + }, + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L47" + } + }, + { + "type": "Object", + "label": "{ expressions }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceSetupDeps", + "text": "IndexPatternsServiceSetupDeps" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L46" + } + }, + { + "id": "def-server.IndexPatternsServiceProvider.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", { fieldFormats, logger }: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceStartDeps", + "text": "IndexPatternsServiceStartDeps" + }, + ") => { indexPatternsServiceFactory: (savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58" + } + }, + { + "type": "Object", + "label": "{ fieldFormats, logger }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.IndexPatternsServiceStartDeps", + "text": "IndexPatternsServiceStartDeps" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58" + } + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/index_patterns_service.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L45" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-server.shouldReadFieldFromDocValues", + "type": "Function", + "label": "shouldReadFieldFromDocValues", + "signature": [ + "(aggregatable: boolean, esType: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "aggregatable", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9" + } + }, + { + "type": "string", + "label": "esType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-server.mergeCapabilitiesWithFields", + "type": "Function", + "children": [ + { + "id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities", + "type": "Object", + "label": "rollupIndexCapabilities", + "tags": [], + "description": [], + "children": [ + { + "id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L14" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L14" + } + }, + { + "id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi", + "type": "Object", + "label": "fieldsFromFieldCapsApi", + "tags": [], + "description": [], + "children": [ + { + "id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L15" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L15" + } + }, + { + "type": "Array", + "label": "previousFields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L16" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.getCapabilitiesForRollupIndices", + "type": "Function", + "label": "getCapabilitiesForRollupIndices", + "signature": [ + "(indices: { [key: string]: any; }) => { [key: string]: any; }" + ], + "description": [], + "children": [ + { + "id": "def-server.getCapabilitiesForRollupIndices.indices", + "type": "Object", + "label": "indices", + "tags": [], + "description": [], + "children": [ + { + "id": "def-server.getCapabilitiesForRollupIndices.indices.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.FieldDescriptor", + "type": "Interface", + "label": "FieldDescriptor", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FieldDescriptor.aggregatable", + "type": "boolean", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L21" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L22" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L23" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.searchable", + "type": "boolean", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L24" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L25" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L26" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L27" + }, + "signature": [ + "FieldSubType | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FieldDescriptor", + "type": "Interface", + "label": "FieldDescriptor", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FieldDescriptor.aggregatable", + "type": "boolean", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L21" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L22" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L23" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.searchable", + "type": "boolean", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L24" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L25" + } + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L26" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.FieldDescriptor.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L27" + }, + "signature": [ + "FieldSubType | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L20" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "id": "def-common.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternsService.ensureDefaultIndexPattern", + "type": "Function", + "label": "ensureDefaultIndexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-common.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "isRequired": true, + "signature": [ + "IndexPatternsServiceDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + } + }, + { + "id": "def-common.IndexPatternsService.getIds", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getTitles", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.find", + "type": "Function", + "children": [ + { + "type": "string", + "label": "search", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + }, + { + "type": "number", + "label": "size", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138" + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] + }, + { + "id": "def-common.IndexPatternsService.getIdsWithTitle", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.clearCache", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getCache", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" + }, + ">[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>" + ], + "description": [ + "\nGet default index pattern" + ], + "label": "getDefault", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.setDefault", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + }, + { + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getFieldsForWildcard", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + } + } + ], + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "description": [ + "\nGet field list by providing { pattern }" + ], + "label": "getFieldsForWildcard", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-common.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237" + } + } + ], + "signature": [ + "(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", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nGet field list by providing an index patttern (or spec)" + ], + "label": "getFieldsForIndexPattern", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235" + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-common.IndexPatternsService.refreshFields", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + } + } + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise" + ], + "description": [ + "\nRefresh field list for a given index pattern" + ], + "label": "refreshFields", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.fieldArrayToMap", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "fields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + }, + { + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => Record" + ], + "description": [ + "\nConverts field array to map" + ], + "label": "fieldArrayToMap", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327" + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-common.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObject", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + } + } + ], + "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] + }, + { + "id": "def-common.IndexPatternsService.get", + "type": "Function", + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + } + } + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "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": 464, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.create", + "type": "Function", + "label": "create", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern instance" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + } + ], + "tags": [], + "returnComment": [ + "IndexPattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + } + }, + { + "id": "def-common.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", + "signature": [ + "(spec: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern and save it right away" + ], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Whether to skip field refresh step." + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + } + }, + { + "id": "def-common.IndexPatternsService.createSavedObject", + "type": "Function", + "label": "createSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nSave a new index pattern" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + } + }, + { + "id": "def-common.IndexPatternsService.updateSavedObject", + "type": "Function", + "label": "updateSavedObject", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + ], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547" + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548" + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" + } + }, + { + "id": "def-common.IndexPatternsService.delete", + "type": "Function", + "label": "delete", + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "description": [ + "\nDeletes an index pattern from .kibana index" + ], + "children": [ + { + "type": "string", + "label": "indexPatternId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPattern", + "type": "Class", + "tags": [], + "label": "IndexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " implements ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.IndexPattern.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46" + } + }, + { + "tags": [], + "id": "def-common.IndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.typeMeta", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.fields", + "type": "CompoundType", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => Record; }" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.IndexPattern.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.type", + "type": "string", + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.formatHit", + "type": "Function", + "label": "formatHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63" + }, + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.formatField", + "type": "Function", + "label": "formatField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67" + }, + "signature": [ + "FormatFieldFn" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.flattenHit", + "type": "Function", + "label": "flattenHit", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68" + }, + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.version", + "type": "string", + "label": "version", + "description": [ + "\nSavedObject version" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.sourceFilters", + "type": "Array", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.allowNoIndex", + "type": "boolean", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84" + } + }, + { + "id": "def-common.IndexPattern.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", + "isRequired": true, + "signature": [ + "IndexPatternDeps" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86" + } + }, + { + "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; }" + ], + "description": [ + "\nGet last saved saved object fields" + ], + "label": "getOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPattern.resetOriginalSavedObjectBody", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [ + "\nReset last saved saved object fields. used after saving" + ], + "label": "resetOriginalSavedObjectBody", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPattern.getFieldAttrs", + "type": "Function", + "children": [], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "description": [], + "label": "getFieldAttrs", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPattern.getComputedFields", + "type": "Function", + "label": "getComputedFields", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162" + } + }, + { + "id": "def-common.IndexPattern.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208" + } + }, + { + "id": "def-common.IndexPattern.getSourceFiltering", + "type": "Function", + "label": "getSourceFiltering", + "signature": [ + "() => { excludes: any[]; }" + ], + "description": [ + "\nGet the source filtering configuration for that index." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230" + } + }, + { + "id": "def-common.IndexPattern.addScriptedField", + "type": "Function", + "label": "addScriptedField", + "signature": [ + "(name: string, script: string, fieldType?: string) => Promise" + ], + "description": [ + "\nAdd scripted field to field list\n" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "script", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "script code" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "type": "string", + "label": "fieldType", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244" + } + }, + { + "id": "def-common.IndexPattern.removeScriptedField", + "type": "Function", + "label": "removeScriptedField", + "signature": [ + "(fieldName: string) => void" + ], + "description": [ + "\nRemove scripted field from field list" + ], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270" + } + }, + { + "id": "def-common.IndexPattern.getNonScriptedFields", + "type": "Function", + "label": "getNonScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277" + } + }, + { + "id": "def-common.IndexPattern.getScriptedFields", + "type": "Function", + "label": "getScriptedFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281" + } + }, + { + "id": "def-common.IndexPattern.isTimeBased", + "type": "Function", + "label": "isTimeBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285" + } + }, + { + "id": "def-common.IndexPattern.isTimeNanosBased", + "type": "Function", + "label": "isTimeNanosBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289" + } + }, + { + "id": "def-common.IndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294" + } + }, + { + "id": "def-common.IndexPattern.getFieldByName", + "type": "Function", + "label": "getFieldByName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299" + } + }, + { + "id": "def-common.IndexPattern.getAggregationRestrictions", + "type": "Function", + "label": "getAggregationRestrictions", + "signature": [ + "() => Record> | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304" + } + }, + { + "id": "def-common.IndexPattern.getAsSavedObjectBody", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311" + } + }, + { + "id": "def-common.IndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "description": [ + "\nProvide a field, get its formatter" + ], + "children": [ + { + "type": "CompoundType", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 340, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339" + } + }, + { + "id": "def-common.IndexPattern.addRuntimeField", + "type": "Function", + "label": "addRuntimeField", + "signature": [ + "(name: string, runtimeField: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => void" + ], + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "type": "Object", + "label": "runtimeField", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "description": [ + "Runtime field definition" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360" + } + }, + { + "id": "def-common.IndexPattern.removeRuntimeField", + "type": "Function", + "label": "removeRuntimeField", + "signature": [ + "(name: string) => void" + ], + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Field name" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384" + } + }, + { + "id": "def-common.IndexPattern.getFormatterForFieldNoDefault", + "type": "Function", + "label": "getFormatterForFieldNoDefault", + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" + ], + "children": [ + { + "type": "string", + "label": "fieldname", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404" + } + }, + { + "id": "def-common.IndexPattern.setFieldAttrs", + "type": "Function", + "label": "setFieldAttrs", + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 412, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412" + } + }, + { + "type": "Uncategorized", + "label": "attrName", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 413, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413" + } + }, + { + "type": "Uncategorized", + "label": "value", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 414, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411" + } + }, + { + "id": "def-common.IndexPattern.setFieldCustomLabel", + "type": "Function", + "label": "setFieldCustomLabel", + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "type": "CompoundType", + "label": "customLabel", + "isRequired": false, + "signature": [ + "string | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" + } + }, + { + "id": "def-common.IndexPattern.setFieldCount", + "type": "Function", + "label": "setFieldCount", + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "type": "CompoundType", + "label": "count", + "isRequired": false, + "signature": [ + "number | null | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433" + } + }, + { + "id": "def-common.IndexPattern.setFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + }, + { + "type": "Object", + "label": "format", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPattern.deleteFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + } + } + ], + "signature": [ + "(fieldName: string) => void" + ], + "description": [], + "label": "deleteFieldFormat", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternField", + "type": "Class", + "tags": [], + "label": "IndexPatternField", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " implements ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternField.spec", + "type": "Object", + "label": "spec", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + }, + { + "id": "def-common.IndexPatternField.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21" + } + }, + { + "id": "def-common.IndexPatternField.count", + "type": "number", + "label": "count", + "tags": [], + "description": [ + "\nCount is used for field popularity" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L31" + } + }, + { + "id": "def-common.IndexPatternField.count", + "type": "number", + "label": "count", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L35" + } + }, + { + "id": "def-common.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L39" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L43" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.script", + "type": "string", + "label": "script", + "tags": [], + "description": [ + "\nScript field code" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L50" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.script", + "type": "string", + "label": "script", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.lang", + "type": "string", + "label": "lang", + "tags": [], + "description": [ + "\nScript field language" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.lang", + "type": "string", + "label": "lang", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L65" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L69" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "tags": [], + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L80" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L84" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L89" + } + }, + { + "id": "def-common.IndexPatternField.displayName", + "type": "string", + "label": "displayName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L93" + } + }, + { + "id": "def-common.IndexPatternField.type", + "type": "string", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L101" + } + }, + { + "id": "def-common.IndexPatternField.esTypes", + "type": "Array", + "label": "esTypes", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L107" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.scripted", + "type": "boolean", + "label": "scripted", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L111" + } + }, + { + "id": "def-common.IndexPatternField.searchable", + "type": "boolean", + "label": "searchable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L115" + } + }, + { + "id": "def-common.IndexPatternField.aggregatable", + "type": "boolean", + "label": "aggregatable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L119" + } + }, + { + "id": "def-common.IndexPatternField.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L123" + } + }, + { + "id": "def-common.IndexPatternField.subType", + "type": "Object", + "label": "subType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L127" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.isMapped", + "type": "CompoundType", + "label": "isMapped", + "tags": [], + "description": [ + "\nIs the field part of the index mapping?" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L134" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.sortable", + "type": "boolean", + "label": "sortable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L139" + } + }, + { + "id": "def-common.IndexPatternField.filterable", + "type": "boolean", + "label": "filterable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L146" + } + }, + { + "id": "def-common.IndexPatternField.visualizable", + "type": "boolean", + "label": "visualizable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L154" + } + }, + { + "id": "def-common.IndexPatternField.deleteCount", + "type": "Function", + "label": "deleteCount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L159" + } + }, + { + "id": "def-common.IndexPatternField.toJSON", + "type": "Function", + "label": "toJSON", + "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: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined; customLabel: string | undefined; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L163" + } + }, + { + "id": "def-common.IndexPatternField.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "children": [ + { + "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", + "type": "Object", + "label": "{\n getFormatterForField,\n }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L184" + }, + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L183" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L181" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DuplicateIndexPatternError", + "type": "Class", + "tags": [], + "label": "DuplicateIndexPatternError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.DuplicateIndexPatternError", + "text": "DuplicateIndexPatternError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-common.DuplicateIndexPatternError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L9" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.isFilterable", + "type": "Function", + "label": "isFilterable", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isNestedField", + "type": "Function", + "label": "isNestedField", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.fieldList", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "specs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L35" + } + }, + { + "type": "boolean", + "label": "shortDotsEnable", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L36" + } + } + ], + "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" + } + ], + "description": [], + "label": "fieldList", + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L34" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getIndexPatternLoadMeta", + "type": "Function", + "children": [], + "signature": [ + "() => Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "text": "IndexPatternLoadExpressionFunctionDefinition" + }, + ", \"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": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L41" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.IndexPatternAttributes", + "type": "Interface", + "label": "IndexPatternAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternAttributes.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.fields", + "type": "string", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55" + } + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.typeMeta", + "type": "string", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.sourceFilters", + "type": "string", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.fieldFormatMap", + "type": "string", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.fieldAttrs", + "type": "string", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.runtimeFieldMap", + "type": "string", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternAttributes.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IFieldType", + "type": "Interface", + "label": "IFieldType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IFieldType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.IFieldType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.IFieldType.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.sortable", + "type": "CompoundType", + "label": "sortable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.format", + "type": "Any", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31" + }, + "signature": [ + "((options?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IIndexPatternFieldList", + "type": "Interface", + "label": "IIndexPatternFieldList", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.IIndexPatternFieldList.add", + "type": "Function", + "label": "add", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18" + } + }, + { + "id": "def-common.IIndexPatternFieldList.getAll", + "type": "Function", + "label": "getAll", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L19" + } + }, + { + "id": "def-common.IIndexPatternFieldList.getByName", + "type": "Function", + "label": "getByName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20" + } + }, + { + "id": "def-common.IIndexPatternFieldList.getByType", + "type": "Function", + "label": "getByType", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21" + } + }, + { + "id": "def-common.IIndexPatternFieldList.remove", + "type": "Function", + "label": "remove", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22" + } + }, + { + "id": "def-common.IIndexPatternFieldList.removeAll", + "type": "Function", + "label": "removeAll", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L23" + } + }, + { + "id": "def-common.IIndexPatternFieldList.replaceAll", + "type": "Function", + "label": "replaceAll", + "signature": [ + "(specs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "specs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24" + } + }, + { + "id": "def-common.IIndexPatternFieldList.update", + "type": "Function", + "label": "update", + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25" + } + }, + { + "id": "def-common.IIndexPatternFieldList.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "(options?: { getFormatterForField?: ((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined; } | undefined) => Record ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RuntimeField", + "type": "Interface", + "label": "RuntimeField", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RuntimeField.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L21" + }, + "signature": [ + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + ] + }, + { + "tags": [], + "id": "def-common.RuntimeField.script", + "type": "Object", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L22" + }, + "signature": [ + "{ source: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IIndexPattern", + "type": "Interface", + "label": "IIndexPattern", + "description": [ + "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IIndexPattern.fields", + "type": "Array", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L32" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.IIndexPattern.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L33" + } + }, + { + "tags": [], + "id": "def-common.IIndexPattern.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L34" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IIndexPattern.type", + "type": "string", + "label": "type", + "description": [ + "\nType is used for identifying rollup indices, otherwise left undefined" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L38" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IIndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L39" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.IIndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "(() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | undefined) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L40" + } + }, + { + "tags": [], + "id": "def-common.IIndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L41" + }, + "signature": [ + "Record | undefined> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IIndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "description": [ + "\nLook up a formatter for a given field" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L45" + }, + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldAttrs", + "type": "Interface", + "label": "FieldAttrs", + "description": [], + "tags": [ + "intenal" + ], + "children": [ + { + "id": "def-common.FieldAttrs.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L75" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldAttrSet", + "type": "Interface", + "label": "FieldAttrSet", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldAttrSet.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L79" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldAttrSet.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L80" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L78" + }, + "initialIsOpen": false + }, + { + "id": "def-common.UiSettingsCommon", + "type": "Interface", + "label": "UiSettingsCommon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UiSettingsCommon.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L87" + }, + "signature": [ + "(key: string) => Promise" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.getAll", + "type": "Function", + "label": "getAll", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L88" + }, + "signature": [ + "() => Promise>" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.set", + "type": "Function", + "label": "set", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L89" + }, + "signature": [ + "(key: string, value: any) => Promise" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.remove", + "type": "Function", + "label": "remove", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L90" + }, + "signature": [ + "(key: string) => Promise" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L86" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectsClientCommonFindArgs", + "type": "Interface", + "label": "SavedObjectsClientCommonFindArgs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L94" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.fields", + "type": "Array", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L95" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L96" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.search", + "type": "string", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L97" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", + "type": "Array", + "label": "searchFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L98" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L93" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectsClientCommon", + "type": "Interface", + "label": "SavedObjectsClientCommon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.find", + "type": "Function", + "label": "find", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L102" + }, + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]>" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L103" + }, + "signature": [ + "(type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L104" + }, + "signature": [ + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.create", + "type": "Function", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L110" + }, + "signature": [ + "(type: string, attributes: Record, options: Record) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.delete", + "type": "Function", + "label": "delete", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L115" + }, + "signature": [ + "(type: string, id: string) => Promise<{}>" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L101" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFieldsOptions", + "type": "Interface", + "label": "GetFieldsOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFieldsOptions.pattern", + "type": "string", + "label": "pattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L119" + } + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L120" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.lookBack", + "type": "CompoundType", + "label": "lookBack", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L121" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L122" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.rollupIndex", + "type": "string", + "label": "rollupIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L123" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L124" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L118" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFieldsOptionsTimePattern", + "type": "Interface", + "label": "GetFieldsOptionsTimePattern", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFieldsOptionsTimePattern.pattern", + "type": "string", + "label": "pattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L128" + } + }, + { + "tags": [], + "id": "def-common.GetFieldsOptionsTimePattern.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L129" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptionsTimePattern.lookBack", + "type": "number", + "label": "lookBack", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L130" + } + }, + { + "tags": [], + "id": "def-common.GetFieldsOptionsTimePattern.interval", + "type": "string", + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L131" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L127" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IIndexPatternsApiClient", + "type": "Interface", + "label": "IIndexPatternsApiClient", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern", + "type": "Function", + "label": "getFieldsForTimePattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L135" + }, + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptionsTimePattern", + "text": "GetFieldsOptionsTimePattern" + }, + ") => Promise" + ] + }, + { + "tags": [], + "id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard", + "type": "Function", + "label": "getFieldsForWildcard", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L136" + }, + "signature": [ + "(options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L134" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IFieldSubType", + "type": "Interface", + "label": "IFieldSubType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IFieldSubType.multi", + "type": "Object", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154" + }, + "signature": [ + "{ parent: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IFieldSubType.nested", + "type": "Object", + "label": "nested", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155" + }, + "signature": [ + "{ path: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TypeMeta", + "type": "Interface", + "label": "TypeMeta", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TypeMeta.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L159" + }, + "signature": [ + "Record> | undefined" + ] + }, + { + "id": "def-common.TypeMeta.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L160" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L158" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldSpecExportFmt", + "type": "Interface", + "label": "FieldSpecExportFmt", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L167" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L168" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L169" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L170" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L171" + } + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.type", + "type": "Enum", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L172" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L173" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.scripted", + "type": "boolean", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L174" + } + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.searchable", + "type": "boolean", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L175" + } + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.aggregatable", + "type": "boolean", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L176" + } + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L177" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L178" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.format", + "type": "Object", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L179" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.indexed", + "type": "CompoundType", + "label": "indexed", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L180" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L166" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldSpec", + "type": "Interface", + "label": "FieldSpec", + "description": [ + "\nSerialized version of IndexPatternField" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FieldSpec.count", + "type": "number", + "label": "count", + "description": [ + "\nPopularity count is used by discover" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L190" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.script", + "type": "string", + "label": "script", + "description": [ + "\nScripted field painless script" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L194" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.lang", + "type": "string", + "label": "lang", + "description": [ + "\nScripted field langauge\nPainless is the only valid scripted field language" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L199" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L200" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.format", + "type": "Object", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 201, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L201" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L202" + } + }, + { + "tags": [], + "id": "def-common.FieldSpec.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L203" + } + }, + { + "tags": [], + "id": "def-common.FieldSpec.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L204" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L205" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.searchable", + "type": "boolean", + "label": "searchable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L206" + } + }, + { + "tags": [], + "id": "def-common.FieldSpec.aggregatable", + "type": "boolean", + "label": "aggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L207" + } + }, + { + "tags": [], + "id": "def-common.FieldSpec.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L208" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L209" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.indexed", + "type": "CompoundType", + "label": "indexed", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L210" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L211" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.runtimeField", + "type": "Object", + "label": "runtimeField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L212" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.shortDotsEnable", + "type": "CompoundType", + "label": "shortDotsEnable", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L214" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.isMapped", + "type": "CompoundType", + "label": "isMapped", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L215" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L186" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternSpec", + "type": "Interface", + "label": "IndexPatternSpec", + "description": [ + "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternSpec.id", + "type": "string", + "label": "id", + "description": [ + "\nsaved object id" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L228" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.version", + "type": "string", + "label": "version", + "description": [ + "\nsaved object version string" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L232" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L233" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.IndexPatternSpec.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L238" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L239" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.sourceFilters", + "type": "Array", + "label": "sourceFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L240" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.fields", + "type": "Object", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L241" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.typeMeta", + "type": "Object", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L242" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L243" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L244" + }, + "signature": [ + "Record>> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.runtimeFieldMap", + "type": "Object", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L245" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.fieldAttrs", + "type": "Object", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L246" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L247" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L224" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SourceFilter", + "type": "Interface", + "label": "SourceFilter", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SourceFilter.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L251" + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L250" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternExpressionType", + "type": "Interface", + "label": "IndexPatternExpressionType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L18" + }, + "signature": [ + "\"index_pattern\"" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L17" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-common.IndexPatternsContract", + "type": "Type", + "label": "IndexPatternsContract", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 638, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L638" + }, + "signature": [ + "{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => 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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatMap", + "type": "Type", + "label": "FieldFormatMap", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L17" + }, + "signature": [ + "{ [x: string]: SerializedFieldFormat>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RuntimeType", + "type": "Type", + "label": "RuntimeType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L19" + }, + "signature": [ + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.OnNotification", + "type": "Type", + "label": "OnNotification", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L83" + }, + "signature": [ + "(toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + }, + ") => void" + ], + "initialIsOpen": false + }, + { + "id": "def-common.OnError", + "type": "Type", + "label": "OnError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L84" + }, + "signature": [ + "(error: Error, toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => void" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggregationRestrictions", + "type": "Type", + "label": "AggregationRestrictions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L141" + }, + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldSpecConflictDescriptions", + "type": "Type", + "label": "FieldSpecConflictDescriptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L163" + }, + "signature": [ + "{ [x: string]: string[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternFieldMap", + "type": "Type", + "label": "IndexPatternFieldMap", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L218" + }, + "signature": [ + "{ [x: string]: FieldSpec; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "label": "IndexPatternLoadExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34" + }, + "signature": [ + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.RUNTIME_FIELD_TYPES", + "type": "Object", + "label": "RUNTIME_FIELD_TYPES", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/constants.ts#L9" + }, + "signature": [ + "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]" + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/data_index_patterns.mdx b/api_docs/data_index_patterns.mdx new file mode 100644 index 0000000000000..df226467aefdc --- /dev/null +++ b/api_docs/data_index_patterns.mdx @@ -0,0 +1,41 @@ +--- +id: kibDataIndexPatternsPluginApi +slug: /kibana-dev-docs/data.indexPatternsPluginApi +title: data.indexPatterns +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.indexPatterns plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.indexPatterns'] +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 dataIndexPatternsObj from './data_index_patterns.json'; + +## Server + +### Functions + + +### Classes + + +### Interfaces + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/data_query.json b/api_docs/data_query.json new file mode 100644 index 0000000000000..e8d5ff79ec80c --- /dev/null +++ b/api_docs/data_query.json @@ -0,0 +1,2618 @@ +{ + "id": "data.query", + "client": { + "classes": [ + { + "id": "def-public.FilterManager", + "type": "Class", + "tags": [], + "label": "FilterManager", + "description": [], + "children": [ + { + "id": "def-public.FilterManager.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "uiSettings", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35" + } + }, + { + "id": "def-public.FilterManager.getFilters", + "type": "Function", + "label": "getFilters", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L92" + } + }, + { + "id": "def-public.FilterManager.getAppFilters", + "type": "Function", + "label": "getAppFilters", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L96" + } + }, + { + "id": "def-public.FilterManager.getGlobalFilters", + "type": "Function", + "label": "getGlobalFilters", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L101" + } + }, + { + "id": "def-public.FilterManager.getPartitionedFilters", + "type": "Function", + "label": "getPartitionedFilters", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.PartitionedFilters", + "text": "PartitionedFilters" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L106" + } + }, + { + "id": "def-public.FilterManager.getUpdates$", + "type": "Function", + "label": "getUpdates$", + "signature": [ + "() => ", + "Observable", + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L110" + } + }, + { + "id": "def-public.FilterManager.getFetches$", + "type": "Function", + "label": "getFetches$", + "signature": [ + "() => ", + "Observable", + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L114" + } + }, + { + "id": "def-public.FilterManager.addFilters", + "type": "Function", + "label": "addFilters", + "signature": [ + "(filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], pinFilterStatus?: boolean) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L121" + } + }, + { + "type": "boolean", + "label": "pinFilterStatus", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L122" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L120" + } + }, + { + "id": "def-public.FilterManager.setFilters", + "type": "Function", + "label": "setFilters", + "signature": [ + "(newFilters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[], pinFilterStatus?: boolean) => void" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "newFilters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 149, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L149" + } + }, + { + "type": "boolean", + "label": "pinFilterStatus", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L150" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 148, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L148" + } + }, + { + "id": "def-public.FilterManager.setGlobalFilters", + "type": "Function", + "label": "setGlobalFilters", + "signature": [ + "(newGlobalFilters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]) => void" + ], + "description": [ + "\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" + ], + "children": [ + { + "type": "Array", + "label": "newGlobalFilters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167" + } + }, + { + "id": "def-public.FilterManager.setAppFilters", + "type": "Function", + "label": "setAppFilters", + "signature": [ + "(newAppFilters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]) => void" + ], + "description": [ + "\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" + ], + "children": [ + { + "type": "Array", + "label": "newAppFilters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184" + } + }, + { + "id": "def-public.FilterManager.removeFilter", + "type": "Function", + "label": "removeFilter", + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + ") => void" + ], + "description": [], + "children": [ + { + "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/public/query/filter_manager/filter_manager.ts", + "lineNumber": 195, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 195, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195" + } + }, + { + "id": "def-public.FilterManager.removeAll", + "type": "Function", + "label": "removeAll", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L207" + } + }, + { + "id": "def-public.FilterManager.setFiltersStore", + "type": "Function", + "label": "setFiltersStore", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + ".setFiltersStore" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L212" + } + }, + { + "type": "Enum", + "label": "store", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L213" + } + }, + { + "type": "boolean", + "label": "shouldOverrideStore", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L214" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L211" + } + } + ], + "source": { + "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TimeHistory", + "type": "Class", + "tags": [], + "label": "TimeHistory", + "description": [], + "children": [ + { + "id": "def-public.TimeHistory.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "storage", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IStorageWrapper", + "text": "IStorageWrapper" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18" + } + }, + { + "id": "def-public.TimeHistory.add", + "type": "Function", + "label": "add", + "signature": [ + "(time: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "time", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29" + } + }, + { + "id": "def-public.TimeHistory.get", + "type": "Function", + "label": "get", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L42" + } + } + ], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L15" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.createSavedQueryService", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObjectsClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L21" + } + } + ], + "signature": [ + "(savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">) => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + } + ], + "description": [], + "label": "createSavedQueryService", + "source": { + "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.connectToQueryState", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", + "isRequired": true, + "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" + }, + "; queryString: Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringManager", + "text": "QueryStringManager" + }, + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + }, + "; state$: ", + "Observable" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L24" + } + }, + { + "type": "Object", + "label": "stateContainer", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.BaseStateContainer", + "text": "BaseStateContainer" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L30" + } + }, + { + "id": "def-public.connectToQueryState.syncConfig", + "type": "Object", + "label": "syncConfig", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.connectToQueryState.syncConfig.time", + "type": "CompoundType", + "label": "time", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L32" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.connectToQueryState.syncConfig.refreshInterval", + "type": "CompoundType", + "label": "refreshInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L33" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.connectToQueryState.syncConfig.filters", + "type": "CompoundType", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L34" + }, + "signature": [ + "boolean | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.connectToQueryState.syncConfig.query", + "type": "CompoundType", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L35" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L31" + } + } + ], + "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: ", + { + "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L23" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.syncQueryStateWithUrl", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "query", + "isRequired": true, + "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" + }, + "; queryString: Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringManager", + "text": "QueryStringManager" + }, + ", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + }, + "; state$: ", + "Observable" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L27" + } + }, + { + "type": "Object", + "label": "kbnUrlStateStorage", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L28" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.getDefaultQuery", + "type": "Function", + "label": "getDefaultQuery", + "signature": [ + "(language: ", + "QueryLanguage", + ") => { query: string; language: ", + "QueryLanguage", + "; }" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "language", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryLanguage", + "text": "QueryLanguage" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.QueryState", + "type": "Interface", + "label": "QueryState", + "description": [ + "\nAll query state service state" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.QueryState.time", + "type": "Object", + "label": "time", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L15" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryState.refreshInterval", + "type": "Object", + "label": "refreshInterval", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L16" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryState.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryState.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L18" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedQuery", + "type": "Interface", + "label": "SavedQuery", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedQuery.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.SavedQuery.attributes", + "type": "Object", + "label": "attributes", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryAttributes", + "text": "SavedQueryAttributes" + } + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedQueryService", + "type": "Interface", + "label": "SavedQueryService", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedQueryService.saveQuery", + "type": "Function", + "label": "saveQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L29" + }, + "signature": [ + "(attributes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQueryAttributes", + "text": "SavedQueryAttributes" + }, + ", config?: { overwrite: boolean; } | undefined) => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.SavedQueryService.getAllSavedQueries", + "type": "Function", + "label": "getAllSavedQueries", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L33" + }, + "signature": [ + "() => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + "[]>" + ] + }, + { + "tags": [], + "id": "def-public.SavedQueryService.findSavedQueries", + "type": "Function", + "label": "findSavedQueries", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L34" + }, + "signature": [ + "(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + "[]; }>" + ] + }, + { + "tags": [], + "id": "def-public.SavedQueryService.getSavedQuery", + "type": "Function", + "label": "getSavedQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L39" + }, + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.SavedQueryService.deleteSavedQuery", + "type": "Function", + "label": "deleteSavedQuery", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L40" + }, + "signature": [ + "(id: string) => Promise<{}>" + ] + }, + { + "tags": [], + "id": "def-public.SavedQueryService.getSavedQueryCount", + "type": "Function", + "label": "getSavedQueryCount", + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L41" + }, + "signature": [ + "() => Promise" + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.QueryStateChange", + "type": "Interface", + "label": "QueryStateChange", + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + " extends QueryStateChangePartial" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.QueryStateChange.appFilters", + "type": "CompoundType", + "label": "appFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStateChange.globalFilters", + "type": "CompoundType", + "label": "globalFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L27" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L25" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.SavedQueryTimeFilter", + "type": "Type", + "label": "SavedQueryTimeFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L11" + }, + "signature": [ + "TimeRange & { refreshInterval: RefreshInterval; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.InputTimeRange", + "type": "Type", + "label": "InputTimeRange", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/types.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | { from: moment.Moment; to: moment.Moment; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TimefilterContract", + "type": "Type", + "label": "TimefilterContract", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/timefilter.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/timefilter.ts#L240" + }, + "signature": [ + "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ", + "Observable", + "; getTimeUpdate$: () => ", + "Observable", + "; getRefreshIntervalUpdate$: () => ", + "Observable", + "; getAutoRefreshFetch$: () => ", + "Observable", + "; getFetch$: () => ", + "Observable" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TimeHistoryContract", + "type": "Type", + "label": "TimeHistoryContract", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L47" + }, + "signature": [ + "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.QueryStart", + "type": "Type", + "label": "QueryStart", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/query_service.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/query_service.ts#L103" + }, + "signature": [ + "{ addToQueryLog: (appName: string, { language, query }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void; filterManager: FilterManager; queryString: Pick; savedQueries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.SavedQueryService", + "text": "SavedQueryService" + }, + "; state$: ", + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + "; state: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + } + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.dedupFilters", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "existingFilters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L23" + } + }, + { + "type": "Array", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L24" + } + }, + { + "type": "Object", + "label": "comparatorOptions", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L25" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L22" + }, + "tags": [], + "returnComment": [ + "An array of filters that were not in existing" + ], + "initialIsOpen": false + }, + { + "id": "def-common.uniqFilters", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "filters", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21" + } + }, + { + "type": "Any", + "label": "comparatorOptions", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21" + }, + "tags": [], + "returnComment": [ + "The original filters array with duplicates removed" + ], + "initialIsOpen": false + }, + { + "id": "def-common.compareFilters", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "first", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L65" + } + }, + { + "type": "CompoundType", + "label": "second", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L66" + } + }, + { + "type": "Object", + "label": "comparatorOptions", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L67" + } + } + ], + "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" + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L64" + }, + "tags": [], + "returnComment": [ + "Filters are the same" + ], + "initialIsOpen": false + }, + { + "id": "def-common.calculateBounds", + "type": "Function", + "label": "calculateBounds", + "signature": [ + "(timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", options: CalculateBoundsOptions) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + } + ], + "description": [], + "children": [ + { + "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/query/timefilter/get_time.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L17" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "CalculateBoundsOptions" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getAbsoluteTimeRange", + "type": "Function", + "label": "getAbsoluteTimeRange", + "signature": [ + "(timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", { forceNow }: { forceNow?: Date | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "description": [], + "children": [ + { + "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/query/timefilter/get_time.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L27" + } + }, + { + "id": "def-common.getAbsoluteTimeRange.{-forceNow }", + "type": "Object", + "label": "{ forceNow }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.getAbsoluteTimeRange.{-forceNow }.forceNow", + "type": "Object", + "label": "forceNow", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28" + }, + "signature": [ + "Date | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getTime", + "type": "Function", + "label": "getTime", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined, timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilter", + "text": "RangeFilter" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38" + } + }, + { + "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/query/timefilter/get_time.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39" + } + }, + { + "id": "def-common.getTime.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.getTime.options.forceNow", + "type": "Object", + "label": "forceNow", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "Date | undefined" + ] + }, + { + "tags": [], + "id": "def-common.getTime.options.fieldName", + "type": "string", + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isTimeRange", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "description": [], + "label": "isTimeRange", + "source": { + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isQuery", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11" + } + } + ], + "signature": [ + "(x: unknown) => x is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ], + "description": [], + "label": "isQuery", + "source": { + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.FilterCompareOptions", + "type": "Interface", + "label": "FilterCompareOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FilterCompareOptions.index", + "type": "CompoundType", + "label": "index", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L13" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FilterCompareOptions.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L14" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FilterCompareOptions.negate", + "type": "CompoundType", + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FilterCompareOptions.state", + "type": "CompoundType", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L16" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FilterCompareOptions.alias", + "type": "CompoundType", + "label": "alias", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L17" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RefreshInterval", + "type": "Interface", + "label": "RefreshInterval", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RefreshInterval.pause", + "type": "boolean", + "label": "pause", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.RefreshInterval.value", + "type": "number", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TimeRangeBounds", + "type": "Interface", + "label": "TimeRangeBounds", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TimeRangeBounds.min", + "type": "Object", + "label": "min", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L24" + }, + "signature": [ + "moment.Moment | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TimeRangeBounds.max", + "type": "Object", + "label": "max", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L25" + }, + "signature": [ + "moment.Moment | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L23" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-common.Query", + "type": "Type", + "label": "Query", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12" + }, + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.TimeRange", + "type": "Type", + "label": "TimeRange", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17" + }, + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-common.COMPARE_ALL_OPTIONS", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.COMPARE_ALL_OPTIONS.index", + "type": "boolean", + "label": "index", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L24" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.COMPARE_ALL_OPTIONS.disabled", + "type": "boolean", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L25" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.COMPARE_ALL_OPTIONS.negate", + "type": "boolean", + "label": "negate", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L26" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.COMPARE_ALL_OPTIONS.state", + "type": "boolean", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L27" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.COMPARE_ALL_OPTIONS.alias", + "type": "boolean", + "label": "alias", + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/compare_filters.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L28" + }, + "signature": [ + "true" + ] + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L23" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx new file mode 100644 index 0000000000000..ae804971a4319 --- /dev/null +++ b/api_docs/data_query.mdx @@ -0,0 +1,41 @@ +--- +id: kibDataQueryPluginApi +slug: /kibana-dev-docs/data.queryPluginApi +title: data.query +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.query plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dataQueryObj from './data_query.json'; + +## Client + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/data_search.json b/api_docs/data_search.json new file mode 100644 index 0000000000000..d03bb23e9bc93 --- /dev/null +++ b/api_docs/data_search.json @@ -0,0 +1,20250 @@ +{ + "id": "data.search", + "client": { + "classes": [ + { + "id": "def-public.SearchInterceptor", + "type": "Class", + "tags": [], + "label": "SearchInterceptor", + "description": [], + "children": [ + { + "id": "def-public.SearchInterceptor.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "deps", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchInterceptorDeps", + "text": "SearchInterceptorDeps" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L70" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L70" + } + }, + { + "id": "def-public.SearchInterceptor.getTimeoutMode", + "type": "Function", + "label": "getTimeoutMode", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.TimeoutErrorMode", + "text": "TimeoutErrorMode" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L86" + } + }, + { + "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" + }, + ", timeoutSignal: AbortSignal, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Error" + ], + "description": [], + "children": [ + { + "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": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L95" + } + }, + { + "type": "Object", + "label": "timeoutSignal", + "isRequired": true, + "signature": [ + "AbortSignal" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L96" + } + }, + { + "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": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L97" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L94" + } + }, + { + "id": "def-public.SearchInterceptor.search", + "type": "Function", + "label": "search", + "signature": [ + "(request: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + ">" + ], + "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" + ], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L233" + } + }, + { + "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": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L234" + } + } + ], + "tags": [ + "options" + ], + "returnComment": [ + "`Observable` emitting the search response or an error." + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L232" + } + }, + { + "id": "def-public.SearchInterceptor.showError", + "type": "Function", + "label": "showError", + "signature": [ + "(e: Error) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "e", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L261" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L261" + } + } + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchTimeoutError", + "type": "Class", + "tags": [], + "label": "SearchTimeoutError", + "description": [ + "\nRequest Failure - When an entire multi request fails" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchTimeoutError", + "text": "SearchTimeoutError" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "tags": [], + "id": "def-public.SearchTimeoutError.mode", + "type": "Enum", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L26" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.TimeoutErrorMode", + "text": "TimeoutErrorMode" + } + ] + }, + { + "id": "def-public.SearchTimeoutError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "err", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27" + } + }, + { + "type": "Enum", + "label": "mode", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.TimeoutErrorMode", + "text": "TimeoutErrorMode" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27" + } + }, + { + "id": "def-public.SearchTimeoutError.getErrorMessage", + "type": "Function", + "label": "getErrorMessage", + "signature": [ + "(application: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + }, + ") => JSX.Element" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "application", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L80" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L80" + } + } + ], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PainlessError", + "type": "Class", + "tags": [], + "label": "PainlessError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.PainlessError", + "text": "PainlessError" + }, + " extends ", + "EsError" + ], + "children": [ + { + "tags": [], + "id": "def-public.PainlessError.painlessStack", + "type": "string", + "label": "painlessStack", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.PainlessError.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L21" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + }, + { + "id": "def-public.PainlessError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "err", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.IEsError", + "text": "IEsError" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22" + } + }, + { + "id": "def-public.PainlessError.getErrorMessage", + "type": "Function", + "label": "getErrorMessage", + "signature": [ + "(application: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + }, + ") => JSX.Element" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "application", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L27" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L27" + } + } + ], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L19" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.getEsPreference", + "type": "Function", + "label": "getEsPreference", + "signature": [ + "(uiSettings: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + ", sessionId: string) => any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "uiSettings", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" + } + }, + { + "type": "string", + "label": "sessionId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.ISearchSetup", + "type": "Interface", + "label": "ISearchSetup", + "description": [ + "\nThe setup contract exposed by the Search plugin exposes the search strategy extension\npoint." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ISearchSetup.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L29" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetup", + "text": "AggsCommonSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.ISearchSetup.usageCollector", + "type": "Object", + "label": "usageCollector", + "description": [], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L30" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchUsageCollector", + "text": "SearchUsageCollector" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ISearchSetup.session", + "type": "Object", + "label": "session", + "description": [ + "\nCurrent session management\n{@link ISessionService}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L35" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SessionService", + "text": "SessionService" + }, + ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + ] + }, + { + "tags": [], + "id": "def-public.ISearchSetup.sessionsClient", + "type": "Object", + "label": "sessionsClient", + "description": [ + "\nSearch sessions SO CRUD\n{@link ISessionsClient}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L40" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SessionsClient", + "text": "SessionsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ISearchStart", + "type": "Interface", + "label": "ISearchStart", + "description": [ + "\nsearch service" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ISearchStart.aggs", + "type": "Object", + "label": "aggs", + "description": [ + "\nagg config sub service\n{@link AggsStart}\n" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L57" + }, + "signature": [ + "Pick & Pick<{ types: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypesRegistryStart", + "text": "AggTypesRegistryStart" + }, + "; }, \"types\"> & Pick<{ types: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypesRegistryStart", + "text": "AggTypesRegistryStart" + }, + "; }, never>, \"calculateAutoTimeExpression\" | \"getDateMetaByDatatableColumn\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" + ] + }, + { + "tags": [], + "id": "def-public.ISearchStart.search", + "type": "Function", + "label": "search", + "description": [ + "\nlow level search\n{@link ISearchGeneric}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L62" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } + ] + }, + { + "tags": [], + "id": "def-public.ISearchStart.showError", + "type": "Function", + "label": "showError", + "description": [], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L64" + }, + "signature": [ + "(e: Error) => void" + ] + }, + { + "tags": [], + "id": "def-public.ISearchStart.searchSource", + "type": "Object", + "label": "searchSource", + "description": [ + "\nhigh level search\n{@link ISearchStartSearchSource}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L69" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchStartSearchSource", + "text": "ISearchStartSearchSource" + } + ] + }, + { + "tags": [], + "id": "def-public.ISearchStart.session", + "type": "Object", + "label": "session", + "description": [ + "\nCurrent session management\n{@link ISessionService}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L74" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SessionService", + "text": "SessionService" + }, + ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + ] + }, + { + "tags": [], + "id": "def-public.ISearchStart.sessionsClient", + "type": "Object", + "label": "sessionsClient", + "description": [ + "\nSearch sessions SO CRUD\n{@link ISessionsClient}" + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L79" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SessionsClient", + "text": "SessionsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L51" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchInterceptorDeps", + "type": "Interface", + "label": "SearchInterceptorDeps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.bfetch", + "type": "Object", + "label": "bfetch", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L36" + }, + "signature": [ + { + "pluginId": "bfetch", + "scope": "public", + "docId": "kibBfetchPluginApi", + "section": "def-public.BfetchPublicContract", + "text": "BfetchPublicContract" + } + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.http", + "type": "Object", + "label": "http", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L37" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L38" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.startServices", + "type": "Object", + "label": "startServices", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L39" + }, + "signature": [ + "Promise<[", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", any, unknown]>" + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.toasts", + "type": "Object", + "label": "toasts", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L40" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.usageCollector", + "type": "Object", + "label": "usageCollector", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L41" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchUsageCollector", + "text": "SearchUsageCollector" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchInterceptorDeps.session", + "type": "Object", + "label": "session", + "description": [], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L42" + }, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SessionService", + "text": "SessionService" + }, + ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/search_interceptor.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchSessionInfoProvider", + "type": "Interface", + "label": "SearchSessionInfoProvider", + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchSessionInfoProvider", + "text": "SearchSessionInfoProvider" + }, + "" + ], + "description": [ + "\nProvide info about current search session to be stored in the Search Session saved object" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchSessionInfoProvider.getName", + "type": "Function", + "label": "getName", + "description": [ + "\nUser-facing name of the session.\ne.g. will be displayed in saved Search Sessions management list" + ], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L39" + }, + "signature": [ + "() => Promise" + ] + }, + { + "tags": [], + "id": "def-public.SearchSessionInfoProvider.getUrlGeneratorData", + "type": "Function", + "label": "getUrlGeneratorData", + "description": [], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L40" + }, + "signature": [ + "() => Promise<{ urlGeneratorId: ID; initialState: ", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorStateMapping", + "text": "UrlGeneratorStateMapping" + }, + "[ID][\"State\"]; restoreState: ", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorStateMapping", + "text": "UrlGeneratorStateMapping" + }, + "[ID][\"State\"]; }>" + ] + } + ], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L34" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.SearchSessionState", + "type": "Enum", + "label": "SearchSessionState", + "tags": [ + "public" + ], + "description": [ + "\nPossible state that current session can be in\n" + ], + "source": { + "path": "src/plugins/data/public/search/session/search_session_state.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/search_session_state.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TimeoutErrorMode", + "type": "Enum", + "label": "TimeoutErrorMode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/timeout_error.tsx", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L15" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.EsdslExpressionFunctionDefinition", + "type": "Type", + "label": "EsdslExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/expressions/esdsl.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/expressions/esdsl.ts#L30" + }, + "signature": [ + "ExpressionFunctionDefinition<\"esdsl\", ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + "> | null, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EsRawResponseExpressionTypeDefinition", + "type": "Type", + "label": "EsRawResponseExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/expressions/es_raw_response.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/expressions/es_raw_response.ts#L57" + }, + "signature": [ + "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.noSearchSessionStorageCapabilityMessage", + "type": "string", + "label": "noSearchSessionStorageCapabilityMessage", + "description": [ + "\nMessage to display in case storing\nsession session is disabled due to turned off capability" + ], + "source": { + "path": "src/plugins/data/public/search/session/i18n.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/i18n.ts#L15" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.SEARCH_SESSIONS_MANAGEMENT_ID", + "type": "string", + "label": "SEARCH_SESSIONS_MANAGEMENT_ID", + "description": [], + "source": { + "path": "src/plugins/data/public/search/session/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/constants.ts#L9" + }, + "signature": [ + "\"search_sessions\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ISessionService", + "type": "Type", + "label": "ISessionService", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/session/session_service.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L25" + }, + "signature": [ + "{ start: () => string; destroy: () => void; readonly state$: 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; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ISessionsClient", + "type": "Type", + "label": "ISessionsClient", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/search/session/sessions_client.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/sessions_client.ts#L13" + }, + "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>; extend: (sessionId: string, expires: string) => Promise>; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.getDefaultSearchParams", + "type": "Function", + "label": "getDefaultSearchParams", + "signature": [ + "(uiSettingsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + ") => Promise>>, \"max_concurrent_shard_requests\" | \"ignore_unavailable\" | \"track_total_hits\">>" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "uiSettingsClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.getShardTimeout", + "type": "Function", + "label": "getShardTimeout", + "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", + ") => boolean; isLessThan: (other: ", + "ByteSizeValue", + ") => boolean; isEqualTo: (other: ", + "ByteSizeValue", + ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<", + "Search", + "<", + "RequestBody" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "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", + ") => boolean; isLessThan: (other: ", + "ByteSizeValue", + ") => boolean; isEqualTo: (other: ", + "ByteSizeValue", + ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/es_search/request_utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.usageProvider", + "type": "Function", + "label": "usageProvider", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ") => ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchUsage", + "text": "SearchUsage" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-server.searchUsageObserver", + "type": "Function", + "label": "searchUsageObserver", + "signature": [ + "(logger: ", + "Logger", + ", usage: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchUsage", + "text": "SearchUsage" + }, + " | undefined) => { next(response: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + "): void; error(): void; }" + ], + "description": [ + "\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain." + ], + "children": [ + { + "type": "Object", + "label": "logger", + "isRequired": true, + "signature": [ + "Logger" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64" + } + }, + { + "type": "Object", + "label": "usage", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchUsage", + "text": "SearchUsage" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.ISearchStrategy", + "type": "Interface", + "label": "ISearchStrategy", + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStrategy", + "text": "ISearchStrategy" + }, + "" + ], + "description": [ + "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ISearchStrategy.search", + "type": "Function", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L75" + }, + "signature": [ + "(request: SearchStrategyRequest, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ", deps: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + }, + ") => ", + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-server.ISearchStrategy.cancel", + "type": "Function", + "label": "cancel", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L80" + }, + "signature": [ + "((id: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ", deps: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + }, + ") => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ISearchStrategy.extend", + "type": "Function", + "label": "extend", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L81" + }, + "signature": [ + "((id: string, keepAlive: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ", deps: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + }, + ") => Promise) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L71" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ISearchSetup", + "type": "Interface", + "label": "ISearchSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ISearchSetup.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L43" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetup", + "text": "AggsCommonSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.ISearchSetup.registerSearchStrategy", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L48" + }, + "signature": [ + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", SearchStrategyResponse extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " = ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">(name: string, strategy: ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStrategy", + "text": "ISearchStrategy" + } + ] + }, + { + "tags": [], + "id": "def-server.ISearchSetup.usage", + "type": "Object", + "label": "usage", + "description": [ + "\nUsed internally for telemetry" + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L59" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchUsage", + "text": "SearchUsage" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ISearchStart", + "type": "Interface", + "label": "ISearchStart", + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStart", + "text": "ISearchStart" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ISearchStart.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L103" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.AggsStart", + "text": "AggsStart" + } + ] + }, + { + "tags": [], + "id": "def-server.ISearchStart.getSearchStrategy", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L109" + }, + "signature": [ + "(name?: string | undefined) => ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchStrategy", + "text": "ISearchStrategy" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.ISearchStart.asScoped", + "type": "Function", + "label": "asScoped", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L112" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.IScopedSearchClient", + "text": "IScopedSearchClient" + } + ] + }, + { + "tags": [], + "id": "def-server.ISearchStart.searchSource", + "type": "Object", + "label": "searchSource", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L113" + }, + "signature": [ + "{ asScoped: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchStartSearchSource", + "text": "ISearchStartSearchSource" + }, + ">; }" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L99" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SearchStrategyDependencies", + "type": "Interface", + "label": "SearchStrategyDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.savedObjectsClient", + "type": "Object", + "label": "savedObjectsClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L36" + }, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ] + }, + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.esClient", + "type": "Object", + "label": "esClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L37" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ] + }, + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.uiSettingsClient", + "type": "Object", + "label": "uiSettingsClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L38" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ] + }, + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.searchSessionsClient", + "type": "Object", + "label": "searchSessionsClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L39" + }, + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.IScopedSearchSessionsClient", + "text": "IScopedSearchSessionsClient" + }, + "" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SearchUsage", + "type": "Interface", + "label": "SearchUsage", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.SearchUsage.trackError", + "type": "Function", + "label": "trackError", + "signature": [ + "() => Promise" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L18" + } + }, + { + "id": "def-server.SearchUsage.trackSuccess", + "type": "Function", + "label": "trackSuccess", + "signature": [ + "(duration: number) => Promise" + ], + "description": [], + "children": [ + { + "type": "number", + "label": "duration", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ISearchSessionService", + "type": "Interface", + "label": "ISearchSessionService", + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchSessionService", + "text": "ISearchSessionService" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ISearchSessionService.asScopedProvider", + "type": "Function", + "label": "asScopedProvider", + "description": [], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/types.ts#L37" + }, + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.IScopedSearchSessionsClient", + "text": "IScopedSearchSessionsClient" + }, + "" + ] + } + ], + "source": { + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/types.ts#L36" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.SearchRequestHandlerContext", + "type": "Type", + "label": "SearchRequestHandlerContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L118" + }, + "signature": [ + "IScopedSearchClient" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [ + { + "id": "def-common.AggConfig", + "type": "Class", + "tags": [], + "label": "AggConfig", + "description": [], + "children": [ + { + "id": "def-common.AggConfig.ensureIds", + "type": "Function", + "label": "ensureIds", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".ensureIds" + ], + "description": [ + "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" + ], + "children": [ + { + "type": "Array", + "label": "list", + "isRequired": true, + "signature": [ + "any[]" + ], + "description": [ + "- a list of objects, objects can be anything really" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "- the list that was passed in" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63" + } + }, + { + "id": "def-common.AggConfig.nextId", + "type": "Function", + "label": "nextId", + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ".nextId" + ], + "description": [ + "\nCalculate the next id based on the ids in this list\n" + ], + "children": [ + { + "type": "Array", + "label": "list", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "list - a list of objects with id properties" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83" + } + }, + { + "tags": [], + "id": "def-common.AggConfig.aggConfigs", + "type": "Object", + "label": "aggConfigs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L92" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ] + }, + { + "tags": [], + "id": "def-common.AggConfig.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L93" + } + }, + { + "tags": [], + "id": "def-common.AggConfig.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L94" + } + }, + { + "tags": [], + "id": "def-common.AggConfig.params", + "type": "Any", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L95" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.AggConfig.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L96" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggConfig.brandNew", + "type": "CompoundType", + "label": "brandNew", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L97" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggConfig.schema", + "type": "string", + "label": "schema", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L98" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.AggConfig.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "aggConfigs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + }, + { + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104" + } + }, + { + "id": "def-common.AggConfig.setParams", + "type": "Function", + "label": "setParams", + "signature": [ + "(from: any) => void" + ], + "description": [ + "\nWrite the current values to this.params, filling in the defaults as we go\n" + ], + "children": [ + { + "type": "Any", + "label": "from", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "- optional object to read values from,\n used when initializing" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134" + } + }, + { + "id": "def-common.AggConfig.getParam", + "type": "Function", + "label": "getParam", + "signature": [ + "(key: string) => any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171" + } + }, + { + "id": "def-common.AggConfig.write", + "type": "Function", + "label": "write", + "signature": [ + "(aggs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined) => Record" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "aggs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175" + } + }, + { + "id": "def-common.AggConfig.isFilterable", + "type": "Function", + "label": "isFilterable", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L179" + } + }, + { + "id": "def-common.AggConfig.createFilter", + "type": "Function", + "label": "createFilter", + "signature": [ + "(key: string, params?: {}) => any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "{}" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183" + } + }, + { + "id": "def-common.AggConfig.onSearchRequestStart", + "type": "Function", + "label": "onSearchRequestStart", + "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\">, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise | Promise" + ], + "description": [ + "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" + ], + "children": [ + { + "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/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + }, + { + "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/common/search/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209" + } + }, + { + "id": "def-common.AggConfig.toDsl", + "type": "Function", + "label": "toDsl", + "signature": [ + "(aggConfigs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined) => any" + ], + "description": [ + "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" + ], + "children": [ + { + "type": "Object", + "label": "aggConfigs", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "description": [ + "- the config object to convert" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230" + } + }, + { + "id": "def-common.AggConfig.serialize", + "type": "Function", + "label": "serialize", + "signature": [ + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "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": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L259" + } + }, + { + "id": "def-common.AggConfig.toJSON", + "type": "Function", + "label": "toJSON", + "signature": [ + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; }" + ], + "description": [], + "children": [], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 290, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L290" + } + }, + { + "id": "def-common.AggConfig.toSerializedFieldFormat", + "type": "Function", + "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" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L301" + } + }, + { + "id": "def-common.AggConfig.toExpressionAst", + "type": "Function", + "label": "toExpressionAst", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | 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": 310, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L310" + } + }, + { + "id": "def-common.AggConfig.getAggParams", + "type": "Function", + "label": "getAggParams", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 365, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L365" + } + }, + { + "id": "def-common.AggConfig.getRequestAggs", + "type": "Function", + "label": "getRequestAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L369" + } + }, + { + "id": "def-common.AggConfig.getResponseAggs", + "type": "Function", + "label": "getResponseAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 373, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L373" + } + }, + { + "id": "def-common.AggConfig.getValue", + "type": "Function", + "label": "getValue", + "signature": [ + "(bucket: any) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "bucket", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 377, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 377, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377" + } + }, + { + "id": "def-common.AggConfig.getKey", + "type": "Function", + "label": "getKey", + "signature": [ + "(bucket: any, key?: string | undefined) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "bucket", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + }, + { + "type": "string", + "label": "key", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" + } + }, + { + "id": "def-common.AggConfig.getFieldDisplayName", + "type": "Function", + "label": "getFieldDisplayName", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 389, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L389" + } + }, + { + "id": "def-common.AggConfig.getField", + "type": "Function", + "label": "getField", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L395" + } + }, + { + "id": "def-common.AggConfig.getValueBucketPath", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 404, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L404" + } + }, + { + "id": "def-common.AggConfig.makeLabel", + "type": "Function", + "label": "makeLabel", + "signature": [ + "(percentageMode?: boolean) => any" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "percentageMode", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 408, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408" + } + }, + { + "id": "def-common.AggConfig.getIndexPattern", + "type": "Function", + "label": "getIndexPattern", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 422, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L422" + } + }, + { + "id": "def-common.AggConfig.getTimeRange", + "type": "Function", + "label": "getTimeRange", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L426" + } + }, + { + "id": "def-common.AggConfig.fieldName", + "type": "Function", + "label": "fieldName", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 430, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L430" + } + }, + { + "id": "def-common.AggConfig.fieldIsTimeField", + "type": "Function", + "label": "fieldIsTimeField", + "signature": [ + "() => boolean | \"\" | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 435, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L435" + } + }, + { + "id": "def-common.AggConfig.type", + "type": "Object", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 442, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L442" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ] + }, + { + "id": "def-common.AggConfig.type", + "type": "Object", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 446, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L446" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ] + }, + { + "id": "def-common.AggConfig.setType", + "type": "Function", + "label": "setType", + "signature": [ + "(type: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "type", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggConfigs", + "type": "Class", + "tags": [], + "label": "AggConfigs", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.AggConfigs.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L58" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ] + }, + { + "tags": [], + "id": "def-common.AggConfigs.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L59" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggConfigs.aggs", + "type": "Array", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L62" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ] + }, + { + "id": "def-common.AggConfigs.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L65" + } + }, + { + "type": "Array", + "label": "configStates", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L66" + } + }, + { + "type": "Object", + "label": "opts", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigsOptions", + "text": "AggConfigsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L64" + } + }, + { + "id": "def-common.AggConfigs.setTimeRange", + "type": "Function", + "label": "setTimeRange", + "signature": [ + "(timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void" + ], + "description": [], + "children": [ + { + "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/aggs/agg_configs.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79" + } + }, + { + "id": "def-common.AggConfigs.clone", + "type": "Function", + "label": "clone", + "signature": [ + "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ enabledOnly = true }", + "isRequired": true, + "signature": [ + "{ enabledOnly?: boolean | undefined; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97" + } + }, + { + "id": "def-common.AggConfigs.createAggConfig", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L111" + } + }, + { + "type": "Object", + "label": "{ addToAggConfigs = true }", + "isRequired": true, + "signature": [ + "{ addToAggConfigs?: boolean | undefined; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L112" + } + } + ], + "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" + } + ], + "description": [], + "label": "createAggConfig", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L110" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.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" + ], + "children": [ + { + "type": "Array", + "label": "aggConfigs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [ + "an AggConfigs instance" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153" + } + }, + { + "id": "def-common.AggConfigs.toDsl", + "type": "Function", + "label": "toDsl", + "signature": [ + "(hierarchical?: boolean) => Record" + ], + "description": [], + "children": [ + { + "type": "boolean", + "label": "hierarchical", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165" + } + }, + { + "id": "def-common.AggConfigs.getAll", + "type": "Function", + "label": "getAll", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L227" + } + }, + { + "id": "def-common.AggConfigs.byIndex", + "type": "Function", + "label": "byIndex", + "signature": [ + "(index: number) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "children": [ + { + "type": "number", + "label": "index", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231" + } + }, + { + "id": "def-common.AggConfigs.byId", + "type": "Function", + "label": "byId", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235" + } + }, + { + "id": "def-common.AggConfigs.byName", + "type": "Function", + "label": "byName", + "signature": [ + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239" + } + }, + { + "id": "def-common.AggConfigs.byType", + "type": "Function", + "label": "byType", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243" + } + }, + { + "id": "def-common.AggConfigs.byTypeName", + "type": "Function", + "label": "byTypeName", + "signature": [ + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247" + } + }, + { + "id": "def-common.AggConfigs.bySchemaName", + "type": "Function", + "label": "bySchemaName", + "signature": [ + "(schema: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "schema", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251" + } + }, + { + "id": "def-common.AggConfigs.getRequestAggs", + "type": "Function", + "label": "getRequestAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L255" + } + }, + { + "id": "def-common.AggConfigs.getRequestAggById", + "type": "Function", + "label": "getRequestAggById", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269" + } + }, + { + "id": "def-common.AggConfigs.getResponseAggs", + "type": "Function", + "label": "getResponseAggs", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "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": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L284" + } + }, + { + "id": "def-common.AggConfigs.getResponseAggById", + "type": "Function", + "label": "getResponseAggById", + "signature": [ + "(id: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | 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" + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- the id of the agg to find" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298" + } + }, + { + "id": "def-common.AggConfigs.onSearchRequestStart", + "type": "Function", + "label": "onSearchRequestStart", + "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\">, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" + ], + "description": [], + "children": [ + { + "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/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + }, + { + "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/common/search/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 307, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggType", + "type": "Class", + "tags": [], + "label": "AggType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + "" + ], + "children": [ + { + "tags": [ + "property", + "type" + ], + "id": "def-common.AggType.name", + "type": "string", + "label": "name", + "description": [ + "\nthe unique, unchanging, name that we have assigned this aggType\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L70" + } + }, + { + "tags": [], + "id": "def-common.AggType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L72" + } + }, + { + "tags": [], + "id": "def-common.AggType.subtype", + "type": "string", + "label": "subtype", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "property", + "type" + ], + "id": "def-common.AggType.dslName", + "type": "string", + "label": "dslName", + "description": [ + "\nthe name of the elasticsearch aggregation that this aggType represents. Usually just this.name\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L80" + } + }, + { + "tags": [ + "property", + "type" + ], + "id": "def-common.AggType.expressionName", + "type": "string", + "label": "expressionName", + "description": [ + "\nthe name of the expression function that this aggType represents.\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L87" + } + }, + { + "tags": [ + "property", + "type" + ], + "id": "def-common.AggType.title", + "type": "string", + "label": "title", + "description": [ + "\nthe user friendly name that will be shown in the ui for this aggType\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L94" + } + }, + { + "tags": [], + "id": "def-common.AggType.valueType", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L99" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L108" + }, + "signature": [ + "((aggConfig: TAggConfig) => string) | (() => string)" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L123" + }, + "signature": [ + "any" + ] + }, + { + "tags": [ + "type" + ], + "id": "def-common.AggType.hasNoDsl", + "type": "boolean", + "label": "hasNoDsl", + "description": [ + "\nFlag that prevents this aggregation from being included in the dsl. This is only\nused by the count aggregation (currently) since it doesn't really exist and it's output\nis available on every bucket.\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L131" + } + }, + { + "tags": [], + "id": "def-common.AggType.createFilter", + "type": "Function", + "label": "createFilter", + "description": [ + "\nThe method to create a filter representation of the bucket" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L138" + }, + "signature": [ + "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" + ] + }, + { + "tags": [ + "property", + "type" + ], + "id": "def-common.AggType.params", + "type": "Array", + "label": "params", + "description": [ + "\nAn instance of {{#crossLink \"AggParams\"}}{{/crossLink}}.\n" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L145" + }, + "signature": [ + "TParam[]" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L155" + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L166" + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" + ] + }, + { + "tags": [], + "id": "def-common.AggType.decorateAggConfig", + "type": "Function", + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L171" + }, + "signature": [ + "() => any" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L184" + }, + "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" + ] + }, + { + "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": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L202" + }, + "signature": [ + "(agg: TAggConfig) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.AggType.getValue", + "type": "Function", + "label": "getValue", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L204" + }, + "signature": [ + "(agg: TAggConfig, bucket: any) => any" + ] + }, + { + "tags": [], + "id": "def-common.AggType.getKey", + "type": "Function", + "label": "getKey", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L206" + }, + "signature": [ + "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" + ] + }, + { + "id": "def-common.AggType.paramByName", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L208" + } + } + ], + "signature": [ + "(name: string) => TParam | undefined" + ], + "description": [], + "label": "paramByName", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L208" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.AggType.getValueBucketPath", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "agg", + "isRequired": true, + "signature": [ + "TAggConfig" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L212" + } + } + ], + "signature": [ + "(agg: TAggConfig) => string" + ], + "description": [], + "label": "getValueBucketPath", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L212" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.AggType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [ + "\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n" + ], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypeConfig", + "text": "AggTypeConfig" + }, + ">" + ], + "description": [ + "- used to set the properties of the AggType" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L225" + } + } + ], + "tags": [ + "class", + "private" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L225" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggTypesRegistry", + "type": "Class", + "tags": [], + "label": "AggTypesRegistry", + "description": [], + "children": [ + { + "id": "def-common.AggTypesRegistry.setup", + "type": "Function", + "children": [], + "signature": [ + "() => { registerBucket: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + ">(name: N, type: T) => void; registerMetric: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + ">(name: N, type: T) => void; }" + ], + "description": [], + "label": "setup", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L31" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.AggTypesRegistry.start", + "type": "Function", + "children": [], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L60" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggsCommonService", + "type": "Class", + "tags": [], + "label": "AggsCommonService", + "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." + ], + "children": [ + { + "id": "def-common.AggsCommonService.setup", + "type": "Function", + "label": "setup", + "signature": [ + "({ registerFunction }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetupDependencies", + "text": "AggsCommonSetupDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetup", + "text": "AggsCommonSetup" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ registerFunction }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetupDependencies", + "text": "AggsCommonSetupDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L56" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L56" + } + }, + { + "id": "def-common.AggsCommonService.start", + "type": "Function", + "label": "start", + "signature": [ + "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonStartDependencies", + "text": "AggsCommonStartDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonStart", + "text": "AggsCommonStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonStartDependencies", + "text": "AggsCommonStartDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L73" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L73" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BucketAggType", + "type": "Class", + "tags": [], + "label": "BucketAggType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.BucketAggType.getKey", + "type": "Function", + "label": "getKey", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L35" + }, + "signature": [ + "(bucket: any, key: any, agg: TBucketAggConfig) => any" + ] + }, + { + "tags": [], + "id": "def-common.BucketAggType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L36" + } + }, + { + "id": "def-common.BucketAggType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "BucketAggTypeConfig" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CidrMask", + "type": "Class", + "tags": [], + "label": "CidrMask", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.CidrMask.initialAddress", + "type": "Object", + "label": "initialAddress", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L18" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.Ipv4Address", + "text": "Ipv4Address" + } + ] + }, + { + "tags": [], + "id": "def-common.CidrMask.prefixLength", + "type": "number", + "label": "prefixLength", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L19" + } + }, + { + "id": "def-common.CidrMask.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "mask", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21" + } + }, + { + "id": "def-common.CidrMask.getRange", + "type": "Function", + "label": "getRange", + "signature": [ + "() => { from: string; to: string; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L33" + } + }, + { + "id": "def-common.CidrMask.toString", + "type": "Function", + "label": "toString", + "signature": [ + "() => string" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L44" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MetricAggType", + "type": "Class", + "tags": [], + "label": "MetricAggType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.MetricAggType.subtype", + "type": "string", + "label": "subtype", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L41" + } + }, + { + "tags": [], + "id": "def-common.MetricAggType.isScalable", + "type": "Function", + "label": "isScalable", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L42" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-common.MetricAggType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L43" + } + }, + { + "id": "def-common.MetricAggType.getKey", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "getKey", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L45" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.MetricAggType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "MetricAggTypeConfig" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamType", + "type": "Class", + "tags": [], + "label": "AggParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-common.AggParamType.makeAgg", + "type": "Function", + "label": "makeAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15" + }, + "signature": [ + "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" + ] + }, + { + "tags": [], + "id": "def-common.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16" + }, + "signature": [ + "string[]" + ] + }, + { + "id": "def-common.AggParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BaseParamType", + "type": "Class", + "tags": [], + "label": "BaseParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-common.BaseParamType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.advanced", + "type": "boolean", + "label": "advanced", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L19" + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L20" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.write", + "type": "Function", + "label": "write", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L21" + }, + "signature": [ + "(aggConfig: TAggConfig, output: Record, aggConfigs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined, locals?: Record | undefined) => void" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.serialize", + "type": "Function", + "label": "serialize", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L27" + }, + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L28" + }, + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.toExpressionAst", + "type": "Function", + "label": "toExpressionAst", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L29" + }, + "signature": [ + "((value: any) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L30" + }, + "signature": [ + "any[]" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.valueType", + "type": "Any", + "label": "valueType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L31" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L45" + }, + "signature": [ + "(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\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => void" + ] + }, + { + "id": "def-common.BaseParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L51" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L51" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldParamType", + "type": "Class", + "tags": [], + "label": "FieldParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldParamType", + "text": "FieldParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.FieldParamType.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L24" + } + }, + { + "tags": [], + "id": "def-common.FieldParamType.scriptable", + "type": "boolean", + "label": "scriptable", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L25" + } + }, + { + "tags": [], + "id": "def-common.FieldParamType.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L26" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldTypes", + "text": "FieldTypes" + } + ] + }, + { + "tags": [], + "id": "def-common.FieldParamType.onlyAggregatable", + "type": "boolean", + "label": "onlyAggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L27" + } + }, + { + "id": "def-common.FieldParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L29" + } + }, + { + "id": "def-common.FieldParamType.getAvailableFields", + "type": "Function", + "children": [ + { + "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": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L100" + } + } + ], + "signature": [ + "(aggConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], + "description": [ + "\nfilter the fields to the available ones" + ], + "label": "getAvailableFields", + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L100" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.JsonParamType", + "type": "Class", + "tags": [], + "label": "JsonParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.JsonParamType", + "text": "JsonParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "id": "def-common.JsonParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L15" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.OptionedParamType", + "type": "Class", + "tags": [], + "label": "OptionedParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedParamType", + "text": "OptionedParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.OptionedParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" + }, + "[]" + ] + }, + { + "id": "def-common.OptionedParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.StringParamType", + "type": "Class", + "tags": [], + "label": "StringParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.StringParamType", + "text": "StringParamType" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ], + "children": [ + { + "id": "def-common.StringParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L13" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.InvalidEsCalendarIntervalError", + "type": "Class", + "tags": [], + "label": "InvalidEsCalendarIntervalError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "interval", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L14" + } + }, + { + "type": "number", + "label": "value", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L15" + } + }, + { + "type": "CompoundType", + "label": "unit", + "isRequired": true, + "signature": [ + "Unit" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L16" + } + }, + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L13" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.InvalidEsIntervalFormatError", + "type": "Class", + "tags": [], + "label": "InvalidEsIntervalFormatError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-common.InvalidEsIntervalFormatError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "interval", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Ipv4Address", + "type": "Class", + "tags": [], + "label": "Ipv4Address", + "description": [], + "children": [ + { + "id": "def-common.Ipv4Address.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ipAddress", + "isRequired": true, + "signature": [ + "React.ReactText" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25" + } + }, + { + "id": "def-common.Ipv4Address.toString", + "type": "Function", + "label": "toString", + "signature": [ + "() => string" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L50" + } + }, + { + "id": "def-common.Ipv4Address.valueOf", + "type": "Function", + "label": "valueOf", + "signature": [ + "() => number" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L60" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RequestFailure", + "type": "Class", + "tags": [], + "label": "RequestFailure", + "description": [ + "\nRequest Failure - When an entire multi request fails" + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RequestFailure", + "text": "RequestFailure" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.RequestFailure.resp", + "type": "Object", + "label": "resp", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L19" + }, + "signature": [ + "SearchResponse", + " | undefined" + ] + }, + { + "id": "def-common.RequestFailure.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "err", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchError", + "text": "SearchError" + }, + " | null" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" + } + }, + { + "type": "Object", + "label": "resp", + "isRequired": false, + "signature": [ + "SearchResponse", + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSource", + "type": "Class", + "tags": [ + "public" + ], + "label": "SearchSource", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchSource.history", + "type": "Array", + "label": "history", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L112" + }, + "signature": [ + "Record[]" + ] + }, + { + "id": "def-common.SearchSource.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fields", + "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/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + }, + { + "type": "Object", + "label": "dependencies", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116" + } + }, + { + "id": "def-common.SearchSource.setPreferredSearchStrategyId", + "type": "Function", + "label": "setPreferredSearchStrategyId", + "signature": [ + "(searchStrategyId: string) => void" + ], + "description": [ + "**\nPUBLIC API\n\ninternal, dont use" + ], + "children": [ + { + "type": "string", + "label": "searchStrategyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134" + } + }, + { + "id": "def-common.SearchSource.setField", + "type": "Function", + "label": "setField", + "signature": [ + "(field: K, value: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]) => this" + ], + "description": [ + "\nsets value to a single search source field" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [ + ": field name" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + }, + { + "type": "Uncategorized", + "label": "value", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + ": value for the field" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143" + } + }, + { + "id": "def-common.SearchSource.removeField", + "type": "Function", + "label": "removeField", + "signature": [ + "(field: K) => this" + ], + "description": [ + "\nremove field" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [ + ": field name" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155" + } + }, + { + "id": "def-common.SearchSource.setFields", + "type": "Function", + "label": "setFields", + "signature": [ + "(newFields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + ") => this" + ], + "description": [ + "\nInternal, do not use. Overrides all search source fields with the new field array.\n" + ], + "children": [ + { + "type": "Object", + "label": "newFields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "New field array." + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166" + } + } + ], + "tags": [ + "private" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166" + } + }, + { + "id": "def-common.SearchSource.getId", + "type": "Function", + "label": "getId", + "signature": [ + "() => string" + ], + "description": [ + "\nreturns search source id" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L174" + } + }, + { + "id": "def-common.SearchSource.getFields", + "type": "Function", + "label": "getFields", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "\nreturns all search source fields" + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L181" + } + }, + { + "id": "def-common.SearchSource.getField", + "type": "Function", + "label": "getField", + "signature": [ + "(field: K, recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + "\nGets a single field from the fields" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + }, + { + "type": "boolean", + "label": "recurse", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188" + } + }, + { + "id": "def-common.SearchSource.getOwnField", + "type": "Function", + "label": "getOwnField", + "signature": [ + "(field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" + ], + "description": [ + "\nGet the field from our own fields, don't traverse up the chain" + ], + "children": [ + { + "type": "Uncategorized", + "label": "field", + "isRequired": true, + "signature": [ + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199" + } + }, + { + "id": "def-common.SearchSource.create", + "type": "Function", + "label": "create", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "description": [], + "children": [], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L206" + } + }, + { + "id": "def-common.SearchSource.createCopy", + "type": "Function", + "label": "createCopy", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "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": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L213" + } + }, + { + "id": "def-common.SearchSource.createChild", + "type": "Function", + "label": "createChild", + "signature": [ + "(options?: {}) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "description": [ + "\ncreates a new child search source" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + "{}" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227" + } + }, + { + "id": "def-common.SearchSource.setParent", + "type": "Function", + "label": "setParent", + "signature": [ + "(parent?: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + }, + ") => this" + ], + "description": [ + "\nSet a searchSource that this source should inherit from" + ], + "children": [ + { + "type": "Object", + "label": "parent", + "isRequired": false, + "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\"> | undefined" + ], + "description": [ + "- the parent searchSource" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceOptions", + "text": "SearchSourceOptions" + } + ], + "description": [ + "- the inherit options" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "- chainable" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239" + } + }, + { + "id": "def-common.SearchSource.getParent", + "type": "Function", + "label": "getParent", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + " | 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": 249, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L249" + } + }, + { + "id": "def-common.SearchSource.fetch$", + "type": "Function", + "label": "fetch$", + "signature": [ + "(options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + "SearchResponse", + ">" + ], + "description": [ + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257" + } + }, + { + "id": "def-common.SearchSource.fetch", + "type": "Function", + "label": "fetch", + "signature": [ + "(options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse", + ">" + ], + "description": [ + "\nFetch this source and reject the returned Promise on error" + ], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284" + } + } + ], + "tags": [ + "deprecated" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284" + } + }, + { + "id": "def-common.SearchSource.onRequestStart", + "type": "Function", + "label": "onRequestStart", + "signature": [ + "(handler: (searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise) => void" + ], + "description": [ + "\n Add a handler that will be notified whenever requests start" + ], + "children": [ + { + "type": "Function", + "label": "handler", + "isRequired": true, + "signature": [ + "(searchSource: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 294, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L294" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L293" + } + }, + { + "id": "def-common.SearchSource.getSearchRequestBody", + "type": "Function", + "label": "getSearchRequestBody", + "signature": [ + "() => Promise" + ], + "description": [ + "\nReturns body contents of the search request, often referred as query DSL." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L302" + } + }, + { + "id": "def-common.SearchSource.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [ + "\nCompletely destroy the SearchSource." + ], + "children": [], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 311, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L311" + } + }, + { + "id": "def-common.SearchSource.getSerializedFields", + "type": "Function", + "label": "getSerializedFields", + "signature": [ + "(recurse?: boolean) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" + ], + "children": [ + { + "type": "boolean", + "label": "recurse", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 689, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 689, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689" + } + }, + { + "id": "def-common.SearchSource.serialize", + "type": "Function", + "label": "serialize", + "signature": [ + "() => { searchSourceJSON: string; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "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": 718, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L718" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSourceService", + "type": "Class", + "tags": [], + "label": "SearchSourceService", + "description": [], + "children": [ + { + "id": "def-common.SearchSourceService.setup", + "type": "Function", + "label": "setup", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L13" + } + }, + { + "id": "def-common.SearchSourceService.start", + "type": "Function", + "label": "start", + "signature": [ + "(indexPatterns: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + }, + ") => { create: (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" + }, + ">; createEmpty: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPatterns", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15" + } + }, + { + "type": "Object", + "label": "dependencies", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15" + } + }, + { + "id": "def-common.SearchSourceService.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L30" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source_service.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L12" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.isAutoInterval", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "value", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13" + } + } + ], + "signature": [ + "(value: unknown) => boolean" + ], + "description": [], + "label": "isAutoInterval", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isBucketAggType", + "type": "Function", + "label": "isBucketAggType", + "signature": [ + "(aggConfig: any) => boolean" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "aggConfig", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-common.aggDateHistogram", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggDateHistogram", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isDateHistogramBucketAggConfig", + "type": "Function", + "label": "isDateHistogramBucketAggConfig", + "signature": [ + "(agg: any) => boolean" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "agg", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getDateHistogramBucketAgg", + "type": "Function", + "children": [ + { + "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": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74" + } + } + ], + "signature": [ + "({ calculateBounds, isDefaultTimezone, getConfig, }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateHistogramBucketAggDependencies", + "text": "DateHistogramBucketAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketDateHistogramAggConfig", + "text": "IBucketDateHistogramAggConfig" + }, + ">" + ], + "description": [], + "label": "getDateHistogramBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggDateRange", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggDateRange", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getDateRangeBucketAgg", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n isDefaultTimezone,\n getConfig,\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeBucketAggDependencies", + "text": "DateRangeBucketAggDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37" + } + } + ], + "signature": [ + "({ isDefaultTimezone, getConfig, }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeBucketAggDependencies", + "text": "DateRangeBucketAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getDateRangeBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggFilter", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggFilter", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getFilterBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getFilterBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggFilters", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggFilters", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getFiltersBucketAgg", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L43" + } + } + ], + "signature": [ + "({ getConfig }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FiltersBucketAggDependencies", + "text": "FiltersBucketAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getFiltersBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L43" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggGeoHash", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggGeoHash", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L29" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoHashBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getGeoHashBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L37" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggGeoTile", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggGeoTile", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoTitleBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "" + ], + "description": [], + "label": "getGeoTitleBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L29" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggHistogram", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggHistogram", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getHistogramBucketAgg", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51" + } + } + ], + "signature": [ + "({ getConfig, getFieldFormatsStart, }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.HistogramBucketAggDependencies", + "text": "HistogramBucketAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketHistogramAggConfig", + "text": "IBucketHistogramAggConfig" + }, + ">" + ], + "description": [], + "label": "getHistogramBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggIpRange", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggIpRange", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getIpRangeBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getIpRangeBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L38" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.convertDateRangeToString", + "type": "Function", + "label": "convertDateRangeToString", + "signature": [ + "({ from, to }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeKey", + "text": "DateRangeKey" + }, + ", format: (val: any) => string) => string" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ from, to }", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeKey", + "text": "DateRangeKey" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" + } + }, + { + "type": "Function", + "label": "format", + "isRequired": true, + "signature": [ + "(val: any) => string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.convertIPRangeToString", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "range", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpRangeKey", + "text": "IpRangeKey" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" + } + }, + { + "type": "Function", + "label": "format", + "isRequired": true, + "signature": [ + "(val: any) => string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" + } + } + ], + "signature": [ + "(range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpRangeKey", + "text": "IpRangeKey" + }, + ", format: (val: any) => string) => string" + ], + "description": [], + "label": "convertIPRangeToString", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.calcAutoIntervalNear", + "type": "Function", + "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" + ], + "children": [ + { + "type": "number", + "label": "targetBucketCount", + "isRequired": true, + "signature": [ + "number" + ], + "description": [ + "desired number of buckets" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" + } + }, + { + "type": "number", + "label": "duration", + "isRequired": true, + "signature": [ + "number" + ], + "description": [ + "time range the agg covers" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" + }, + "initialIsOpen": false + }, + { + "id": "def-common.calcAutoIntervalLessThan", + "type": "Function", + "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" + ], + "children": [ + { + "type": "number", + "label": "maxBucketCount", + "isRequired": true, + "signature": [ + "number" + ], + "description": [ + "maximum number of buckets to create" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" + } + }, + { + "type": "number", + "label": "duration", + "isRequired": true, + "signature": [ + "number" + ], + "description": [ + "amount of time covered by the agg" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isType", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13" + } + } + ], + "signature": [ + "(...types: string[]) => (agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "description": [], + "label": "isType", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.isNumberType", + "type": "Function", + "label": "isNumberType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L21" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.isStringType", + "type": "Function", + "label": "isStringType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L22" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.isStringOrNumberType", + "type": "Function", + "label": "isStringOrNumberType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L23" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "initialIsOpen": false + }, + { + "id": "def-common.aggRange", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggRange", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getRangeBucketAgg", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L38" + } + } + ], + "signature": [ + "({ getFieldFormatsStart }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RangeBucketAggDependencies", + "text": "RangeBucketAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getRangeBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L38" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggSignificantTerms", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggSignificantTerms", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSignificantTermsBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getSignificantTermsBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L29" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggTerms", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggTerms", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getTermsBucketAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" + ], + "description": [], + "label": "getTermsBucketAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L65" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggAvg", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggAvg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getAvgMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getAvgMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggBucketAvg", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggBucketAvg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getBucketAvgMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getBucketAvgMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggBucketMax", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggBucketMax", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getBucketMaxMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getBucketMaxMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggBucketMin", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggBucketMin", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getBucketMinMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getBucketMinMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggBucketSum", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggBucketSum", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getBucketSumMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getBucketSumMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L30" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggCardinality", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggCardinality", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCardinalityMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getCardinalityMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCountMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getCountMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/count.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count.ts#L14" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggCount", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggCount", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggCumulativeSum", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggCumulativeSum", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L27" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCumulativeSumMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getCumulativeSumMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggDerivative", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggDerivative", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L27" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getDerivativeMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getDerivativeMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggGeoBounds", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggGeoBounds", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoBoundsMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getGeoBoundsMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggGeoCentroid", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggGeoCentroid", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getGeoCentroidMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getGeoCentroidMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggMax", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggMax", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMaxMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getMaxMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggMedian", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggMedian", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMedianMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getMedianMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isMetricAggType", + "type": "Function", + "label": "isMetricAggType", + "signature": [ + "(aggConfig: any) => boolean" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "aggConfig", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75" + }, + "initialIsOpen": false + }, + { + "id": "def-common.aggMin", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggMin", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMinMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getMinMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggMovingAvg", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggMovingAvg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L27" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMovingAvgMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getMovingAvgMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L33" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggPercentileRanks", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggPercentileRanks", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPercentileRanksMetricAgg", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n getFieldFormatsStart,\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.PercentileRanksMetricAggDependencies", + "text": "PercentileRanksMetricAggDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52" + } + } + ], + "signature": [ + "({ getFieldFormatsStart, }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.PercentileRanksMetricAggDependencies", + "text": "PercentileRanksMetricAggDependencies" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + "IResponseAggConfig", + ">" + ], + "description": [], + "label": "getPercentileRanksMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggPercentiles", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggPercentiles", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getPercentilesMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + "IResponseAggConfig", + ">" + ], + "description": [], + "label": "getPercentilesMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L38" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggSerialDiff", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggSerialDiff", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L27" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSerialDiffMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getSerialDiffMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggStdDeviation", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggStdDeviation", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getStdDeviationMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IStdDevAggConfig", + "text": "IStdDevAggConfig" + }, + ">" + ], + "description": [], + "label": "getStdDeviationMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L73" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggSum", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggSum", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSumMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getSumMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.aggTopHit", + "type": "Function", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], + "description": [], + "label": "aggTopHit", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getTopHitMetricAgg", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "" + ], + "description": [], + "label": "getTopHitMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getNumberHistogramIntervalByDatatableColumn", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19" + } + } + ], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCalculateAutoTimeExpression", + "type": "Function", + "label": "getCalculateAutoTimeExpression", + "signature": [ + "(getConfig: (key: string) => any) => (range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => string | undefined" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getConfig", + "isRequired": true, + "signature": [ + "(key: string) => any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.dateHistogramInterval", + "type": "Function", + "label": "dateHistogramInterval", + "signature": [ + "(interval: string) => Interval" + ], + "description": [ + "\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram." + ], + "children": [ + { + "type": "string", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isValidEsInterval", + "type": "Function", + "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" + ], + "children": [ + { + "type": "string", + "label": "interval", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "The interval string like 1w, 24h" + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isValidInterval", + "type": "Function", + "label": "isValidInterval", + "signature": [ + "(value: string, baseInterval: string | undefined) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "value", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" + } + }, + { + "type": "string", + "label": "baseInterval", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.parseInterval", + "type": "Function", + "label": "parseInterval", + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "description": [], + "children": [ + { + "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": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.splitStringInterval", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.parseEsInterval", + "type": "Function", + "label": "parseEsInterval", + "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" + ], + "children": [ + { + "type": "string", + "label": "interval", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-common.toAbsoluteDates", + "type": "Function", + "label": "toAbsoluteDates", + "signature": [ + "(range: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => { from: Date; to: Date; } | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "range", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.propFilter", + "type": "Function", + "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" + ], + "children": [ + { + "type": "Uncategorized", + "label": "prop", + "isRequired": true, + "signature": [ + "P" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.inferTimeZone", + "type": "Function", + "label": "inferTimeZone", + "signature": [ + "(params: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDateHistogram", + "text": "AggParamsDateHistogram" + }, + ", indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDateHistogram", + "text": "AggParamsDateHistogram" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L14" + } + }, + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L15" + } + }, + { + "type": "Function", + "label": "isDefaultTimezone", + "isRequired": true, + "signature": [ + "() => boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L16" + } + }, + { + "type": "Function", + "label": "getConfig", + "isRequired": true, + "signature": [ + "(key: string) => T" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.handleRequest", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n metricsAtAllLevels,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RequestHandlerParams", + "text": "RequestHandlerParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44" + } + } + ], + "signature": [ + "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", + "RequestHandlerParams", + ") => Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ">" + ], + "description": [], + "label": "handleRequest", + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44" + }, + "tags": [], + "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": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22" + } + } + ], + "tags": [ + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getResponseInspectorStats", + "type": "Function", + "label": "getResponseInspectorStats", + "signature": [ + "(resp: ", + "SearchResponse", + ", searchSource: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + }, + ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "resp", + "isRequired": true, + "signature": [ + "SearchResponse", + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L53" + } + }, + { + "type": "Object", + "label": "searchSource", + "isRequired": false, + "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\"> | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L54" + } + } + ], + "tags": [ + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-common.functionWrapper", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "spec", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16" + } + } + ], + "signature": [ + "(spec: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ") => (context: object | null, args?: Record, 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": [ + "\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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createSearchSource", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "indexPatterns", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L32" + } + }, + { + "type": "Object", + "label": "searchSourceDependencies", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/create_search_source.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L33" + } + } + ], + "signature": [ + "(indexPatterns: Pick<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternsService", + "text": "IndexPatternsService" + }, + ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L31" + }, + "tags": [ + "return", + "public" + ], + "returnComment": [ + "Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`." + ], + "initialIsOpen": false + }, + { + "id": "def-common.injectReferences", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "searchSourceFields", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName: string; }" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L13" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L14" + } + } + ], + "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" + } + ], + "description": [], + "label": "injectReferences", + "source": { + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L12" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.extractReferences", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L14" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.parseSearchSourceJSON", + "type": "Function", + "children": [ + { + "type": "string", + "label": "searchSourceJSON", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12" + } + } + ], + "signature": [ + "(searchSourceJSON: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [], + "label": "parseSearchSourceJSON", + "source": { + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getSearchParams", + "type": "Function", + "label": "getSearchParams", + "signature": [ + "(getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ") => { preference: any; }" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getConfig", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getSearchParamsFromRequest", + "type": "Function", + "label": "getSearchParamsFromRequest", + "signature": [ + "(searchRequest: Record, dependencies: { getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + "; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "searchRequest", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L34" + } + }, + { + "id": "def-common.getSearchParamsFromRequest.dependencies", + "type": "Object", + "label": "dependencies", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.getSearchParamsFromRequest.dependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" + } + } + ], + "tags": [ + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getPreference", + "type": "Function", + "label": "getPreference", + "signature": [ + "(getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ") => any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getConfig", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22" + }, + "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": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L20" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L21" + } + }, + { + "type": "Object", + "label": "fetchHandlers", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FetchHandlers", + "text": "FetchHandlers" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.tabify", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L16" + } + }, + { + "type": "Object", + "label": "esResponse", + "isRequired": true, + "signature": [ + "SearchResponse", + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L17" + } + }, + { + "type": "CompoundType", + "label": "opts", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TabbedResponseWriterOptions", + "text": "TabbedResponseWriterOptions" + }, + "> | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TabifyDocsOptions", + "text": "TabifyDocsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L18" + } + } + ], + "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" + } + ], + "description": [], + "label": "tabify", + "source": { + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L15" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.tabifyDocs", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "esResponse", + "isRequired": true, + "signature": [ + "SearchResponse", + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L75" + } + }, + { + "type": "Object", + "label": "index", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L76" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TabifyDocsOptions", + "text": "TabifyDocsOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L77" + } + } + ], + "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" + } + ], + "description": [], + "label": "tabifyDocs", + "source": { + "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L74" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.tabifyAggResponse", + "type": "Function", + "label": "tabifyAggResponse", + "signature": [ + "(aggConfigs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [ + "\nSets up the ResponseWriter and kicks off bucket collection." + ], + "children": [ + { + "type": "Object", + "label": "aggConfigs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L20" + } + }, + { + "type": "Object", + "label": "esResponse", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L21" + } + }, + { + "type": "Object", + "label": "respOpts", + "isRequired": false, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TabbedResponseWriterOptions", + "text": "TabbedResponseWriterOptions" + }, + "> | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.tabifyGetColumns", + "type": "Function", + "label": "tabifyGetColumns", + "signature": [ + "(aggs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[], minimalColumns: boolean) => ", + "TabbedAggColumn", + "[]" + ], + "description": [ + "\nBuilds tabify columns.\n" + ], + "children": [ + { + "type": "Array", + "label": "aggs", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" + ], + "description": [ + "- the agg configs object to which the aggregation response correlates" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34" + } + }, + { + "type": "boolean", + "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" + ], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isErrorResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14" + }, + "tags": [], + "returnComment": [ + "true if response had an error while executing in ES" + ], + "initialIsOpen": false + }, + { + "id": "def-common.isCompleteResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21" + }, + "tags": [], + "returnComment": [ + "true if response is completed successfully" + ], + "initialIsOpen": false + }, + { + "id": "def-common.isPartialResponse", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": false, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28" + }, + "tags": [], + "returnComment": [ + "true if request is still running an/d response contains partial results" + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.AggConfigsOptions", + "type": "Interface", + "label": "AggConfigsOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggConfigsOptions.typesRegistry", + "type": "Object", + "label": "typesRegistry", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L38" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypesRegistryStart", + "text": "AggTypesRegistryStart" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggTypeConfig", + "type": "Interface", + "label": "AggTypeConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggTypeConfig", + "text": "AggTypeConfig" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggTypeConfig.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L26" + } + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L27" + } + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.createFilter", + "type": "Function", + "label": "createFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L28" + }, + "signature": [ + "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L29" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.dslName", + "type": "string", + "label": "dslName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L30" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.expressionName", + "type": "string", + "label": "expressionName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.makeLabel", + "type": "CompoundType", + "label": "makeLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L32" + }, + "signature": [ + "((aggConfig: TAggConfig) => string) | (() => string) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.ordered", + "type": "Any", + "label": "ordered", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L33" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.hasNoDsl", + "type": "CompoundType", + "label": "hasNoDsl", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L34" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.params", + "type": "Array", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L35" + }, + "signature": [ + "Partial[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.valueType", + "type": "CompoundType", + "label": "valueType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L36" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getRequestAggs", + "type": "CompoundType", + "label": "getRequestAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L37" + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getResponseAggs", + "type": "CompoundType", + "label": "getResponseAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L38" + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.customLabels", + "type": "CompoundType", + "label": "customLabels", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L39" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.json", + "type": "CompoundType", + "label": "json", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L40" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.decorateAggConfig", + "type": "Function", + "label": "decorateAggConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L41" + }, + "signature": [ + "(() => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.postFlightRequest", + "type": "Function", + "label": "postFlightRequest", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L42" + }, + "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" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getSerializedFormat", + "type": "Function", + "label": "getSerializedFormat", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L51" + }, + "signature": [ + "((agg: TAggConfig) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getValue", + "type": "Function", + "label": "getValue", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L52" + }, + "signature": [ + "((agg: TAggConfig, bucket: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getKey", + "type": "Function", + "label": "getKey", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L53" + }, + "signature": [ + "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getValueBucketPath", + "type": "Function", + "label": "getValueBucketPath", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L54" + }, + "signature": [ + "((agg: TAggConfig) => string) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IBucketAggConfig", + "type": "Interface", + "label": "IBucketAggConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IBucketAggConfig.type", + "type": "Object", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L15" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BucketAggParam", + "type": "Interface", + "label": "BucketAggParam", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggParam", + "text": "BucketAggParam" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BucketAggParam.scriptable", + "type": "CompoundType", + "label": "scriptable", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BucketAggParam.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L21" + }, + "signature": [ + { + "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.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DateHistogramBucketAggDependencies", + "type": "Interface", + "label": "DateHistogramBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", + "type": "Function", + "label": "calculateBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L48" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CalculateBoundsFn", + "text": "CalculateBoundsFn" + } + ] + }, + { + "tags": [], + "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", + "type": "Function", + "label": "isDefaultTimezone", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L49" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-common.DateHistogramBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L50" + }, + "signature": [ + "(key: string) => T" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IBucketDateHistogramAggConfig", + "type": "Interface", + "label": "IBucketDateHistogramAggConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketDateHistogramAggConfig", + "text": "IBucketDateHistogramAggConfig" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IBucketDateHistogramAggConfig.buckets", + "type": "Object", + "label": "buckets", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L54" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TimeBuckets", + "text": "TimeBuckets" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsDateHistogram", + "type": "Interface", + "label": "AggParamsDateHistogram", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDateHistogram", + "text": "AggParamsDateHistogram" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.field", + "type": "CompoundType", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L62" + }, + "signature": [ + "string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L63" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", + "type": "CompoundType", + "label": "useNormalizedEsInterval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L64" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.scaleMetricValues", + "type": "CompoundType", + "label": "scaleMetricValues", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L65" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.interval", + "type": "string", + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L66" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.time_zone", + "type": "string", + "label": "time_zone", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L67" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.drop_partials", + "type": "CompoundType", + "label": "drop_partials", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L68" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.format", + "type": "string", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L69" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.min_doc_count", + "type": "number", + "label": "min_doc_count", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L70" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.extended_bounds", + "type": "Object", + "label": "extended_bounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L71" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExtendedBounds", + "text": "ExtendedBounds" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DateRangeBucketAggDependencies", + "type": "Interface", + "label": "DateRangeBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", + "type": "Function", + "label": "isDefaultTimezone", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L27" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-common.DateRangeBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L28" + }, + "signature": [ + "(key: string) => T" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsDateRange", + "type": "Interface", + "label": "AggParamsDateRange", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDateRange", + "text": "AggParamsDateRange" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsDateRange.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateRange.ranges", + "type": "Array", + "label": "ranges", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L33" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.DateRangeKey", + "text": "DateRangeKey" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDateRange.time_zone", + "type": "string", + "label": "time_zone", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L34" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsFilter", + "type": "Interface", + "label": "AggParamsFilter", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsFilter", + "text": "AggParamsFilter" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsFilter.geo_bounding_box", + "type": "CompoundType", + "label": "geo_bounding_box", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L21" + }, + "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": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FiltersBucketAggDependencies", + "type": "Interface", + "label": "FiltersBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FiltersBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L33" + }, + "signature": [ + "(key: string) => any" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsFilters", + "type": "Interface", + "label": "AggParamsFilters", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsFilters", + "text": "AggParamsFilters" + }, + " extends Pick<", + "BaseAggParams", + ", \"json\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsFilters.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L37" + }, + "signature": [ + "{ input: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "; label: string; }[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsGeoHash", + "type": "Interface", + "label": "AggParamsGeoHash", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsGeoHash", + "text": "AggParamsGeoHash" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsGeoHash.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L29" + } + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.autoPrecision", + "type": "CompoundType", + "label": "autoPrecision", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L30" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.precision", + "type": "number", + "label": "precision", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L31" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.useGeocentroid", + "type": "CompoundType", + "label": "useGeocentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L32" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.isFilteredByCollar", + "type": "CompoundType", + "label": "isFilteredByCollar", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L33" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.boundingBox", + "type": "CompoundType", + "label": "boundingBox", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L34" + }, + "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": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsGeoTile", + "type": "Interface", + "label": "AggParamsGeoTile", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsGeoTile", + "text": "AggParamsGeoTile" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsGeoTile.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L24" + } + }, + { + "tags": [], + "id": "def-common.AggParamsGeoTile.useGeocentroid", + "type": "CompoundType", + "label": "useGeocentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoTile.precision", + "type": "number", + "label": "precision", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L26" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AutoBounds", + "type": "Interface", + "label": "AutoBounds", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AutoBounds.min", + "type": "number", + "label": "min", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L26" + } + }, + { + "tags": [], + "id": "def-common.AutoBounds.max", + "type": "number", + "label": "max", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L27" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.HistogramBucketAggDependencies", + "type": "Interface", + "label": "HistogramBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.HistogramBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L31" + }, + "signature": [ + "(key: string) => T" + ] + }, + { + "tags": [], + "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L32" + }, + "signature": [ + "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IBucketHistogramAggConfig", + "type": "Interface", + "label": "IBucketHistogramAggConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketHistogramAggConfig", + "text": "IBucketHistogramAggConfig" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", + "type": "Function", + "label": "setAutoBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L36" + }, + "signature": [ + "(bounds: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AutoBounds", + "text": "AutoBounds" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", + "type": "Function", + "label": "getAutoBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L37" + }, + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AutoBounds", + "text": "AutoBounds" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsHistogram", + "type": "Interface", + "label": "AggParamsHistogram", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsHistogram", + "text": "AggParamsHistogram" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsHistogram.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L41" + } + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.interval", + "type": "CompoundType", + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L42" + }, + "signature": [ + "React.ReactText" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.used_interval", + "type": "CompoundType", + "label": "used_interval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L43" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.maxBars", + "type": "number", + "label": "maxBars", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L44" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.intervalBase", + "type": "number", + "label": "intervalBase", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.min_doc_count", + "type": "CompoundType", + "label": "min_doc_count", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L46" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.has_extended_bounds", + "type": "CompoundType", + "label": "has_extended_bounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L47" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.extended_bounds", + "type": "Object", + "label": "extended_bounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L48" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExtendedBounds", + "text": "ExtendedBounds" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsIpRange", + "type": "Interface", + "label": "AggParamsIpRange", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsIpRange", + "text": "AggParamsIpRange" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsIpRange.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.AggParamsIpRange.ipRangeType", + "type": "CompoundType", + "label": "ipRangeType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L31" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IP_RANGE_TYPES", + "text": "IP_RANGE_TYPES" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsIpRange.ranges", + "type": "Object", + "label": "ranges", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L32" + }, + "signature": [ + "Partial<{ fromTo: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RangeIpRangeAggKey", + "text": "RangeIpRangeAggKey" + }, + "[]; mask: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMaskIpRangeAggKey", + "text": "CidrMaskIpRangeAggKey" + }, + "[]; }> | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DateRangeKey", + "type": "Interface", + "label": "DateRangeKey", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DateRangeKey.from", + "type": "CompoundType", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L10" + }, + "signature": [ + "React.ReactText" + ] + }, + { + "tags": [], + "id": "def-common.DateRangeKey.to", + "type": "CompoundType", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L11" + }, + "signature": [ + "React.ReactText" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CidrMaskIpRangeAggKey", + "type": "Interface", + "label": "CidrMaskIpRangeAggKey", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CidrMaskIpRangeAggKey.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L10" + }, + "signature": [ + "\"mask\"" + ] + }, + { + "tags": [], + "id": "def-common.CidrMaskIpRangeAggKey.mask", + "type": "string", + "label": "mask", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L11" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RangeIpRangeAggKey", + "type": "Interface", + "label": "RangeIpRangeAggKey", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RangeIpRangeAggKey.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L15" + }, + "signature": [ + "\"range\"" + ] + }, + { + "tags": [], + "id": "def-common.RangeIpRangeAggKey.from", + "type": "string", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.RangeIpRangeAggKey.to", + "type": "string", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RangeBucketAggDependencies", + "type": "Interface", + "label": "RangeBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L26" + }, + "signature": [ + "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsRange", + "type": "Interface", + "label": "AggParamsRange", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsRange", + "text": "AggParamsRange" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsRange.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.AggParamsRange.ranges", + "type": "Array", + "label": "ranges", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L31" + }, + "signature": [ + "{ from: number; to: number; label?: string | undefined; }[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsSignificantTerms", + "type": "Interface", + "label": "AggParamsSignificantTerms", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsSignificantTerms", + "text": "AggParamsSignificantTerms" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsSignificantTerms.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L23" + } + }, + { + "tags": [], + "id": "def-common.AggParamsSignificantTerms.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L24" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsSignificantTerms.exclude", + "type": "string", + "label": "exclude", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L25" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsSignificantTerms.include", + "type": "string", + "label": "include", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L26" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsTerms", + "type": "Interface", + "label": "AggParamsTerms", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsTerms", + "text": "AggParamsTerms" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsTerms.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L51" + } + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.orderBy", + "type": "string", + "label": "orderBy", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L52" + } + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.orderAgg", + "type": "Object", + "label": "orderAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L53" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.order", + "type": "CompoundType", + "label": "order", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L54" + }, + "signature": [ + "\"asc\" | \"desc\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L55" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.missingBucket", + "type": "CompoundType", + "label": "missingBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L56" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.missingBucketLabel", + "type": "string", + "label": "missingBucketLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L57" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.otherBucket", + "type": "CompoundType", + "label": "otherBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L58" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.otherBucketLabel", + "type": "string", + "label": "otherBucketLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L59" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.exclude", + "type": "string", + "label": "exclude", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.include", + "type": "string", + "label": "include", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L62" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L50" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsAvg", + "type": "Interface", + "label": "AggParamsAvg", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsAvg", + "text": "AggParamsAvg" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsAvg.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsBucketAvg", + "type": "Interface", + "label": "AggParamsBucketAvg", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsBucketAvg", + "text": "AggParamsBucketAvg" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsBucketAvg.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsBucketAvg.customBucket", + "type": "Object", + "label": "customBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L20" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsBucketMax", + "type": "Interface", + "label": "AggParamsBucketMax", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsBucketMax", + "text": "AggParamsBucketMax" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsBucketMax.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L18" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsBucketMax.customBucket", + "type": "Object", + "label": "customBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsBucketMin", + "type": "Interface", + "label": "AggParamsBucketMin", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsBucketMin", + "text": "AggParamsBucketMin" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsBucketMin.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L18" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsBucketMin.customBucket", + "type": "Object", + "label": "customBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsBucketSum", + "type": "Interface", + "label": "AggParamsBucketSum", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsBucketSum", + "text": "AggParamsBucketSum" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsBucketSum.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L18" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsBucketSum.customBucket", + "type": "Object", + "label": "customBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsCardinality", + "type": "Interface", + "label": "AggParamsCardinality", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsCardinality", + "text": "AggParamsCardinality" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsCardinality.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsCumulativeSum", + "type": "Interface", + "label": "AggParamsCumulativeSum", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsCumulativeSum", + "text": "AggParamsCumulativeSum" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsCumulativeSum.buckets_path", + "type": "string", + "label": "buckets_path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsCumulativeSum.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsCumulativeSum.metricAgg", + "type": "string", + "label": "metricAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsDerivative", + "type": "Interface", + "label": "AggParamsDerivative", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDerivative", + "text": "AggParamsDerivative" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsDerivative.buckets_path", + "type": "string", + "label": "buckets_path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDerivative.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsDerivative.metricAgg", + "type": "string", + "label": "metricAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsGeoBounds", + "type": "Interface", + "label": "AggParamsGeoBounds", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsGeoBounds", + "text": "AggParamsGeoBounds" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsGeoBounds.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsGeoCentroid", + "type": "Interface", + "label": "AggParamsGeoCentroid", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsGeoCentroid", + "text": "AggParamsGeoCentroid" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsGeoCentroid.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsMax", + "type": "Interface", + "label": "AggParamsMax", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsMax", + "text": "AggParamsMax" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsMax.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsMedian", + "type": "Interface", + "label": "AggParamsMedian", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsMedian", + "text": "AggParamsMedian" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsMedian.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IMetricAggConfig", + "type": "Interface", + "label": "IMetricAggConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IMetricAggConfig.type", + "type": "Object", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MetricAggParam", + "type": "Interface", + "label": "MetricAggParam", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggParam", + "text": "MetricAggParam" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MetricAggParam.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L22" + }, + "signature": [ + { + "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.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.MetricAggParam.onlyAggregatable", + "type": "CompoundType", + "label": "onlyAggregatable", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsMin", + "type": "Interface", + "label": "AggParamsMin", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsMin", + "text": "AggParamsMin" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsMin.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsMovingAvg", + "type": "Interface", + "label": "AggParamsMovingAvg", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsMovingAvg", + "text": "AggParamsMovingAvg" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.buckets_path", + "type": "string", + "label": "buckets_path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.window", + "type": "number", + "label": "window", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L19" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L21" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.metricAgg", + "type": "string", + "label": "metricAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L22" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsPercentileRanks", + "type": "Interface", + "label": "AggParamsPercentileRanks", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsPercentileRanks", + "text": "AggParamsPercentileRanks" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsPercentileRanks.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.AggParamsPercentileRanks.values", + "type": "Array", + "label": "values", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L23" + }, + "signature": [ + "number[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PercentileRanksMetricAggDependencies", + "type": "Interface", + "label": "PercentileRanksMetricAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L30" + }, + "signature": [ + "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsPercentiles", + "type": "Interface", + "label": "AggParamsPercentiles", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsPercentiles", + "text": "AggParamsPercentiles" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsPercentiles.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.AggParamsPercentiles.percents", + "type": "Array", + "label": "percents", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L21" + }, + "signature": [ + "number[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsSerialDiff", + "type": "Interface", + "label": "AggParamsSerialDiff", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsSerialDiff", + "text": "AggParamsSerialDiff" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsSerialDiff.buckets_path", + "type": "string", + "label": "buckets_path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsSerialDiff.customMetric", + "type": "Object", + "label": "customMetric", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L19" + }, + "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsSerialDiff.metricAgg", + "type": "string", + "label": "metricAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsStdDeviation", + "type": "Interface", + "label": "AggParamsStdDeviation", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsStdDeviation", + "text": "AggParamsStdDeviation" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsStdDeviation.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IStdDevAggConfig", + "type": "Interface", + "label": "IStdDevAggConfig", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IStdDevAggConfig", + "text": "IStdDevAggConfig" + }, + " extends ", + "IResponseAggConfig" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IStdDevAggConfig.keyedDetails", + "type": "Function", + "label": "keyedDetails", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L28" + }, + "signature": [ + "(customLabel: string, fieldDisplayName?: string | undefined) => Record" + ] + }, + { + "tags": [], + "id": "def-common.IStdDevAggConfig.valProp", + "type": "Function", + "label": "valProp", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L29" + }, + "signature": [ + "() => string[]" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsSum", + "type": "Interface", + "label": "AggParamsSum", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsSum", + "text": "AggParamsSum" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsSum.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsTopHit", + "type": "Interface", + "label": "AggParamsTopHit", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsTopHit", + "text": "AggParamsTopHit" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsTopHit.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.aggregate", + "type": "CompoundType", + "label": "aggregate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L19" + }, + "signature": [ + "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L21" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.sortOrder", + "type": "CompoundType", + "label": "sortOrder", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L22" + }, + "signature": [ + "\"asc\" | \"desc\" | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.OptionedValueProp", + "type": "Interface", + "label": "OptionedValueProp", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.OptionedValueProp.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.isCompatible", + "type": "Function", + "label": "isCompatible", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16" + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamOption", + "type": "Interface", + "label": "AggParamOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamOption.val", + "type": "string", + "label": "val", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.AggParamOption.display", + "type": "string", + "label": "display", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32" + } + }, + { + "id": "def-common.AggParamOption.enabled", + "type": "Function", + "label": "enabled", + "signature": [ + "((agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean) | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agg", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggFunctionsMapping", + "type": "Interface", + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggHistogram", + "type": "Object", + "label": "aggHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggTerms", + "type": "Object", + "label": "aggTerms", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "label": "aggBucketAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggBucketMin", + "type": "Object", + "label": "aggBucketMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggBucketSum", + "type": "Object", + "label": "aggBucketSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggGeoBounds", + "type": "Object", + "label": "aggGeoBounds", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggMedian", + "type": "Object", + "label": "aggMedian", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggPercentiles", + "type": "Object", + "label": "aggPercentiles", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 231, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggSerialDiff", + "type": "Object", + "label": "aggSerialDiff", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggStdDeviation", + "type": "Object", + "label": "aggStdDeviation", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggSum", + "type": "Object", + "label": "aggSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 234, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234" + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-common.AggFunctionsMapping.aggTopHit", + "type": "Object", + "label": "aggTopHit", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 235, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235" + }, + "signature": [ + "FunctionDefinition" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IEsSearchRequest", + "type": "Interface", + "label": "IEsSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" + }, + ">>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FetchHandlers", + "type": "Interface", + "label": "FetchHandlers", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FetchHandlers.getConfig", + "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L23" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ] + }, + { + "tags": [], + "id": "def-common.FetchHandlers.onResponse", + "type": "Function", + "label": "onResponse", + "description": [ + "\nCallback which can be used to hook into responses, modify them, or perform\nside effects like displaying UI errors on the client." + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L28" + }, + "signature": [ + "(request: Record, response: ", + "SearchResponse", + ") => ", + "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": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L33" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.LegacyFetchHandlers", + "text": "LegacyFetchHandlers" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchError", + "type": "Interface", + "label": "SearchError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchError.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.SearchError.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L38" + } + }, + { + "tags": [], + "id": "def-common.SearchError.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L39" + } + }, + { + "tags": [], + "id": "def-common.SearchError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L40" + } + }, + { + "tags": [], + "id": "def-common.SearchError.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L41" + } + }, + { + "tags": [], + "id": "def-common.SearchError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L42" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MsearchRequestBody", + "type": "Interface", + "label": "MsearchRequestBody", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MsearchRequestBody.searches", + "type": "Array", + "label": "searches", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L26" + }, + "signature": [ + "MsearchRequest[]" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MsearchResponse", + "type": "Interface", + "label": "MsearchResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MsearchResponse.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L31" + }, + "signature": [ + "ApiResponse", + "<{ responses: ", + "SearchResponse", + "[]; }, ", + "Context", + ">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L30" + }, + "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": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L36" + }, + "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": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L40" + }, + "signature": [ + "BehaviorSubject", + "" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchStrategySearchParams", + "type": "Interface", + "label": "SearchStrategySearchParams", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchStrategySearchParams", + "text": "SearchStrategySearchParams" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FetchHandlers", + "text": "FetchHandlers" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchStrategySearchParams.searchRequests", + "type": "Array", + "label": "searchRequests", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L44" + }, + "signature": [ + "Record[]" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchStrategyProvider", + "type": "Interface", + "label": "SearchStrategyProvider", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchStrategyProvider.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L49" + } + }, + { + "tags": [], + "id": "def-common.SearchStrategyProvider.search", + "type": "Function", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L50" + }, + "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": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchStrategyResponse", + "type": "Interface", + "label": "SearchStrategyResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchStrategyResponse", + "text": "SearchStrategyResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchStrategyResponse.searching", + "type": "Object", + "label": "searching", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L54" + }, + "signature": [ + "Promise<", + "SearchResponse", + "[]>" + ] + }, + { + "tags": [], + "id": "def-common.SearchStrategyResponse.abort", + "type": "Function", + "label": "abort", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L55" + }, + "signature": [ + "() => void" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSourceDependencies", + "type": "Interface", + "label": "SearchSourceDependencies", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FetchHandlers", + "text": "FetchHandlers" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchSourceDependencies.search", + "type": "Function", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L100" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L99" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchStartSearchSource", + "type": "Interface", + "label": "ISearchStartSearchSource", + "description": [ + "\nhigh level search service" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-common.ISearchStartSearchSource.create", + "type": "Function", + "label": "create", + "description": [ + "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L30" + }, + "signature": [ + "(fields?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined) => Promise>" + ] + }, + { + "tags": [], + "id": "def-common.ISearchStartSearchSource.createEmpty", + "type": "Function", + "label": "createEmpty", + "description": [ + "\ncreates empty {@link SearchSource}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L34" + }, + "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\">" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SortDirectionNumeric", + "type": "Interface", + "label": "SortDirectionNumeric", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SortDirectionNumeric.order", + "type": "Enum", + "label": "order", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L45" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + } + ] + }, + { + "tags": [], + "id": "def-common.SortDirectionNumeric.numeric_type", + "type": "CompoundType", + "label": "numeric_type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L46" + }, + "signature": [ + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSourceFields", + "type": "Interface", + "label": "SearchSourceFields", + "description": [ + "\nsearch source fields" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchSourceFields.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.query", + "type": "Object", + "label": "query", + "description": [ + "\n{@link Query}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L66" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.filter", + "type": "CompoundType", + "label": "filter", + "description": [ + "\n{@link Filter}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L70" + }, + "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" + }, + "[] | (() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.sort", + "type": "CompoundType", + "label": "sort", + "description": [ + "\n{@link EsQuerySortValue}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L74" + }, + "signature": [ + "Record | Record[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.highlight", + "type": "Any", + "label": "highlight", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L75" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.highlightAll", + "type": "CompoundType", + "label": "highlightAll", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L76" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.trackTotalHits", + "type": "CompoundType", + "label": "trackTotalHits", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L77" + }, + "signature": [ + "number | boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.aggs", + "type": "Any", + "label": "aggs", + "description": [ + "\n{@link AggConfigs}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L81" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L82" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L83" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.source", + "type": "CompoundType", + "label": "source", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L84" + }, + "signature": [ + "string | boolean | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.version", + "type": "CompoundType", + "label": "version", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L85" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.fields", + "type": "Array", + "label": "fields", + "description": [ + "\nRetrieve fields via the search Fields API" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L89" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchFieldValue", + "text": "SearchFieldValue" + }, + "[] | undefined" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", + "label": "fieldsFromSource", + "description": [ + "\nRetreive fields directly from _source (legacy behavior)\n" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L95" + }, + "signature": [ + "string | boolean | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.index", + "type": "Object", + "label": "index", + "description": [ + "\n{@link IndexPatternService}" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L99" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.searchAfter", + "type": "Object", + "label": "searchAfter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L100" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.timeout", + "type": "string", + "label": "timeout", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L101" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.terminate_after", + "type": "number", + "label": "terminate_after", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L102" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SearchSourceFields.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L104" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSourceOptions", + "type": "Interface", + "label": "SearchSourceOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SearchSourceOptions.callParentStartHandlers", + "type": "CompoundType", + "label": "callParentStartHandlers", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L108" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L107" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SortOptions", + "type": "Interface", + "label": "SortOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SortOptions.mode", + "type": "CompoundType", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L112" + }, + "signature": [ + "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L113" + }, + "signature": [ + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.nested", + "type": "Uncategorized", + "label": "nested", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L114" + }, + "signature": [ + "object | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.unmapped_type", + "type": "string", + "label": "unmapped_type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L115" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.distance_type", + "type": "CompoundType", + "label": "distance_type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L116" + }, + "signature": [ + "\"arc\" | \"plane\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.unit", + "type": "string", + "label": "unit", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L117" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions.ignore_unmapped", + "type": "CompoundType", + "label": "ignore_unmapped", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L118" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SortOptions._script", + "type": "Uncategorized", + "label": "_script", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L119" + }, + "signature": [ + "object | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L111" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Request", + "type": "Interface", + "label": "Request", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Request.docvalue_fields", + "type": "Array", + "label": "docvalue_fields", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L123" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Request._source", + "type": "Unknown", + "label": "_source", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L124" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.query", + "type": "Unknown", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L125" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.script_fields", + "type": "Unknown", + "label": "script_fields", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L126" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.sort", + "type": "Unknown", + "label": "sort", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L127" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.stored_fields", + "type": "Array", + "label": "stored_fields", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L128" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L122" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ResponseWithShardFailure", + "type": "Interface", + "label": "ResponseWithShardFailure", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ResponseWithShardFailure._shards", + "type": "Object", + "label": "_shards", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L132" + }, + "signature": [ + "{ failed: number; failures: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ShardFailure", + "text": "ShardFailure" + }, + "[]; skipped: number; successful: number; total: number; }" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L131" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L142" + } + }, + { + "tags": [], + "id": "def-common.ShardFailure.node", + "type": "string", + "label": "node", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L143" + } + }, + { + "tags": [], + "id": "def-common.ShardFailure.reason", + "type": "Object", + "label": "reason", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L144" + }, + "signature": [ + "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" + ] + }, + { + "tags": [], + "id": "def-common.ShardFailure.shard", + "type": "number", + "label": "shard", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L155" + } + } + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L141" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchClient", + "type": "Interface", + "label": "ISearchClient", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ISearchClient.search", + "type": "Function", + "label": "search", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L29" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } + ] + }, + { + "tags": [], + "id": "def-common.ISearchClient.cancel", + "type": "Function", + "label": "cancel", + "description": [ + "\nUsed to cancel an in-progress search request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L33" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchCancelGeneric", + "text": "ISearchCancelGeneric" + } + ] + }, + { + "tags": [], + "id": "def-common.ISearchClient.extend", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L37" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchExtendGeneric", + "text": "ISearchExtendGeneric" + } + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IKibanaSearchResponse", + "type": "Interface", + "label": "IKibanaSearchResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.id", + "type": "string", + "label": "id", + "description": [ + "\nSome responses may contain a unique id to identify the request this response came from." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L44" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.total", + "type": "number", + "label": "total", + "description": [ + "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L50" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.loaded", + "type": "number", + "label": "loaded", + "description": [ + "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L56" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.isRunning", + "type": "CompoundType", + "label": "isRunning", + "description": [ + "\nIndicates whether search is still in flight" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L61" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.isPartial", + "type": "CompoundType", + "label": "isPartial", + "description": [ + "\nIndicates whether the results returned are complete or partial" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L66" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchResponse.rawResponse", + "type": "Uncategorized", + "label": "rawResponse", + "description": [ + "\nThe raw response returned by the internal search method (usually the raw ES response)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L71" + }, + "signature": [ + "RawResponse" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IKibanaSearchRequest", + "type": "Interface", + "label": "IKibanaSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IKibanaSearchRequest.id", + "type": "string", + "label": "id", + "description": [ + "\nAn id can be used to uniquely identify this request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L78" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IKibanaSearchRequest.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L80" + }, + "signature": [ + "Params | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchOptions", + "type": "Interface", + "label": "ISearchOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ISearchOptions.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87" + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.strategy", + "type": "string", + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.sessionId", + "type": "string", + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.isStored", + "type": "CompoundType", + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.isRestore", + "type": "CompoundType", + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ISearchOptions.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.BUCKET_TYPES", + "type": "Enum", + "label": "BUCKET_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IP_RANGE_TYPES", + "type": "Enum", + "label": "IP_RANGE_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.METRIC_TYPES", + "type": "Enum", + "label": "METRIC_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SortDirection", + "type": "Enum", + "label": "SortDirection", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L39" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-common.AggConfigOptions", + "type": "Type", + "label": "AggConfigOptions", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43" + }, + "signature": [ + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IAggConfig", + "type": "Type", + "label": "IAggConfig", + "tags": [ + "name", + "description" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53" + }, + "signature": [ + "AggConfig" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CreateAggConfigParams", + "type": "Type", + "label": "CreateAggConfigParams", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L41" + }, + "signature": [ + "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggGroupName", + "type": "Type", + "label": "AggGroupName", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18" + }, + "signature": [ + "\"buckets\" | \"metrics\" | \"none\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IAggType", + "type": "Type", + "label": "IAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58" + }, + "signature": [ + "AggType>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggTypesRegistrySetup", + "type": "Type", + "label": "AggTypesRegistrySetup", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L13" + }, + "signature": [ + "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.autoInterval", + "type": "string", + "label": "autoInterval", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L12" + }, + "signature": [ + "\"auto\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.intervalOptions", + "type": "Array", + "label": "intervalOptions", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L15" + }, + "signature": [ + "({ display: string; val: string; enabled(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggDateHistogramFnName", + "type": "string", + "label": "aggDateHistogramFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L15" + }, + "signature": [ + "\"aggDateHistogram\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggDateRangeFnName", + "type": "string", + "label": "aggDateRangeFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L15" + }, + "signature": [ + "\"aggDateRange\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggFilterFnName", + "type": "string", + "label": "aggFilterFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L15" + }, + "signature": [ + "\"aggFilter\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggFiltersFnName", + "type": "string", + "label": "aggFiltersFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L15" + }, + "signature": [ + "\"aggFilters\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggGeoHashFnName", + "type": "string", + "label": "aggGeoHashFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L15" + }, + "signature": [ + "\"aggGeoHash\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggGeoTileFnName", + "type": "string", + "label": "aggGeoTileFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L13" + }, + "signature": [ + "\"aggGeoTile\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggHistogramFnName", + "type": "string", + "label": "aggHistogramFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L15" + }, + "signature": [ + "\"aggHistogram\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggIpRangeFnName", + "type": "string", + "label": "aggIpRangeFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L15" + }, + "signature": [ + "\"aggIpRange\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IpRangeKey", + "type": "Type", + "label": "IpRangeKey", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMaskIpRangeAggKey", + "text": "CidrMaskIpRangeAggKey" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RangeIpRangeAggKey", + "text": "RangeIpRangeAggKey" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.boundsDescendingRaw", + "type": "Array", + "label": "boundsDescendingRaw", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L12" + }, + "signature": [ + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggRangeFnName", + "type": "string", + "label": "aggRangeFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L15" + }, + "signature": [ + "\"aggRange\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggSignificantTermsFnName", + "type": "string", + "label": "aggSignificantTermsFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L13" + }, + "signature": [ + "\"aggSignificantTerms\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggTermsFnName", + "type": "string", + "label": "aggTermsFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L14" + }, + "signature": [ + "\"aggTerms\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.termsAggFilter", + "type": "Array", + "label": "termsAggFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L32" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggAvgFnName", + "type": "string", + "label": "aggAvgFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L13" + }, + "signature": [ + "\"aggAvg\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggBucketAvgFnName", + "type": "string", + "label": "aggBucketAvgFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L14" + }, + "signature": [ + "\"aggBucketAvg\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggBucketMaxFnName", + "type": "string", + "label": "aggBucketMaxFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L14" + }, + "signature": [ + "\"aggBucketMax\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggBucketMinFnName", + "type": "string", + "label": "aggBucketMinFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L14" + }, + "signature": [ + "\"aggBucketMin\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggBucketSumFnName", + "type": "string", + "label": "aggBucketSumFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L14" + }, + "signature": [ + "\"aggBucketSum\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggCardinalityFnName", + "type": "string", + "label": "aggCardinalityFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L13" + }, + "signature": [ + "\"aggCardinality\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggCountFnName", + "type": "string", + "label": "aggCountFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L13" + }, + "signature": [ + "\"aggCount\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggCumulativeSumFnName", + "type": "string", + "label": "aggCumulativeSumFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L14" + }, + "signature": [ + "\"aggCumulativeSum\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggDerivativeFnName", + "type": "string", + "label": "aggDerivativeFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L14" + }, + "signature": [ + "\"aggDerivative\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggGeoBoundsFnName", + "type": "string", + "label": "aggGeoBoundsFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L13" + }, + "signature": [ + "\"aggGeoBounds\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggGeoCentroidFnName", + "type": "string", + "label": "aggGeoCentroidFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L13" + }, + "signature": [ + "\"aggGeoCentroid\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.parentPipelineType", + "type": "string", + "label": "parentPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L26" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.siblingPipelineType", + "type": "string", + "label": "siblingPipelineType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L33" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggMaxFnName", + "type": "string", + "label": "aggMaxFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L13" + }, + "signature": [ + "\"aggMax\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggMedianFnName", + "type": "string", + "label": "aggMedianFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L13" + }, + "signature": [ + "\"aggMedian\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IMetricAggType", + "type": "Type", + "label": "IMetricAggType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35" + }, + "signature": [ + "MetricAggType" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggMinFnName", + "type": "string", + "label": "aggMinFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L13" + }, + "signature": [ + "\"aggMin\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggMovingAvgFnName", + "type": "string", + "label": "aggMovingAvgFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L14" + }, + "signature": [ + "\"aggMovingAvg\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggPercentileRanksFnName", + "type": "string", + "label": "aggPercentileRanksFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L13" + }, + "signature": [ + "\"aggPercentileRanks\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IPercentileRanksAggConfig", + "type": "Type", + "label": "IPercentileRanksAggConfig", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L27" + }, + "signature": [ + "IResponseAggConfig" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggPercentilesFnName", + "type": "string", + "label": "aggPercentilesFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L13" + }, + "signature": [ + "\"aggPercentiles\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IPercentileAggConfig", + "type": "Type", + "label": "IPercentileAggConfig", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L24" + }, + "signature": [ + "IResponseAggConfig" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggSerialDiffFnName", + "type": "string", + "label": "aggSerialDiffFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L14" + }, + "signature": [ + "\"aggSerialDiff\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggStdDeviationFnName", + "type": "string", + "label": "aggStdDeviationFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L13" + }, + "signature": [ + "\"aggStdDeviation\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggSumFnName", + "type": "string", + "label": "aggSumFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L13" + }, + "signature": [ + "\"aggSum\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggTopHitFnName", + "type": "string", + "label": "aggTopHitFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L13" + }, + "signature": [ + "\"aggTopHit\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FieldTypes", + "type": "Type", + "label": "FieldTypes", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L19" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "._SOURCE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ".ATTACHMENT | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ".BOOLEAN | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ".DATE | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.IFieldParamType", + "type": "Type", + "label": "IFieldParamType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21" + }, + "signature": [ + "FieldParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggParam", + "type": "Type", + "label": "AggParam", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28" + }, + "signature": [ + "BaseParamType" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggsStart", + "type": "Type", + "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": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L139" + }, + "signature": [ + "{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, \"type\"> & Pick<{ type: string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + }, + "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ParsedInterval", + "type": "Type", + "label": "ParsedInterval", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18" + }, + "signature": [ + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ES_SEARCH_STRATEGY", + "type": "string", + "label": "ES_SEARCH_STRATEGY", + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13" + }, + "signature": [ + "\"es\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ISearchRequestParams", + "type": "Type", + "label": "ISearchRequestParams", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L15" + }, + "signature": [ + "{ trackTotalHits?: boolean | undefined; } & Search" + ], + "initialIsOpen": false + }, + { + "id": "def-common.IEsSearchResponse", + "type": "Type", + "label": "IEsSearchResponse", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23" + }, + "signature": [ + "IKibanaSearchResponse>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionKibana", + "type": "Type", + "label": "ExpressionFunctionKibana", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, object, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionKibanaContext", + "type": "Type", + "label": "ExpressionFunctionKibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23" + }, + "signature": [ + "ExpressionFunctionDefinition<\"kibana_context\", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionContextSearch", + "type": "Type", + "label": "ExecutionContextSearch", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14" + }, + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueSearchContext", + "type": "Type", + "label": "ExpressionValueSearchContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "id": "def-common.KIBANA_CONTEXT_NAME", + "type": "Type", + "label": "KIBANA_CONTEXT_NAME", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L26" + }, + "signature": [ + "\"kibana_context\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.KibanaContext", + "type": "Type", + "label": "KibanaContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27" + }, + "signature": [ + "{ type: \"kibana_context\"; } & ExecutionContextSearch" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EsaggsExpressionFunctionDefinition", + "type": "Type", + "label": "EsaggsExpressionFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35" + }, + "signature": [ + "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ISearchSource", + "type": "Type", + "label": "ISearchSource", + "tags": [ + "public" + ], + "description": [ + "\nsearch source interface" + ], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L19" + }, + "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", + "docId": "kibDataPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => ", + "Observable", + "<", + "SearchResponse", + ">; fetch: (options?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise<", + "SearchResponse" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EsQuerySearchAfter", + "type": "Type", + "label": "EsQuerySearchAfter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L37" + }, + "signature": [ + "[", + "ReactText", + ", ", + "ReactText", + "]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EsQuerySortValue", + "type": "Type", + "label": "EsQuerySortValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L49" + }, + "signature": [ + "{ [x: string]: SortDirection | SortDirectionNumeric; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SearchFieldValue", + "type": "Type", + "label": "SearchFieldValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L56" + }, + "signature": [ + "string | SearchField" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ISearchGeneric", + "type": "Type", + "label": "ISearchGeneric", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L13" + }, + "signature": [ + "(request: SearchStrategyRequest, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ISearchCancelGeneric", + "type": "Type", + "label": "ISearchCancelGeneric", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L21" + }, + "signature": [ + "(id: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ISearchExtendGeneric", + "type": "Type", + "label": "ISearchExtendGeneric", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L22" + }, + "signature": [ + "(id: string, keepAlive: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-common.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12" + }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AggGroupLabels", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggGroupLabels.[AggGroupNames.Buckets]", + "type": "string", + "label": "[AggGroupNames.Buckets]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.AggGroupLabels.[AggGroupNames.Metrics]", + "type": "string", + "label": "[AggGroupNames.Metrics]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24" + } + }, + { + "tags": [], + "id": "def-common.AggGroupLabels.[AggGroupNames.None]", + "type": "string", + "label": "[AggGroupNames.None]", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27" + } + } + ], + "description": [], + "label": "AggGroupLabels", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.migrateIncludeExcludeFormat", + "type": "Object", + "label": "migrateIncludeExcludeFormat", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L25" + }, + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggParam", + "text": "BucketAggParam" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.parentPipelineAggHelper", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.parentPipelineAggHelper.subtype", + "type": "string", + "label": "subtype", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L34" + } + }, + { + "id": "def-common.parentPipelineAggHelper.params", + "type": "Function", + "label": "params", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggParam", + "text": "MetricAggParam" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L35" + } + }, + { + "id": "def-common.parentPipelineAggHelper.getSerializedFormat", + "type": "Function", + "label": "getSerializedFormat", + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ") => any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agg", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63" + } + } + ], + "description": [], + "label": "parentPipelineAggHelper", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-common.siblingPipelineAggHelper", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.siblingPipelineAggHelper.subtype", + "type": "string", + "label": "subtype", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L41" + } + }, + { + "id": "def-common.siblingPipelineAggHelper.params", + "type": "Function", + "label": "params", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggParam", + "text": "MetricAggParam" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L42" + } + }, + { + "id": "def-common.siblingPipelineAggHelper.getSerializedFormat", + "type": "Function", + "label": "getSerializedFormat", + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ") => any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agg", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77" + } + } + ], + "description": [], + "label": "siblingPipelineAggHelper", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-common.kibana", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibana.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L27" + }, + "signature": [ + "\"kibana\"" + ] + }, + { + "tags": [], + "id": "def-common.kibana.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L28" + }, + "signature": [ + "\"kibana_context\"" + ] + }, + { + "tags": [], + "id": "def-common.kibana.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L30" + }, + "signature": [ + "(\"kibana_context\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibana.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L32" + } + }, + { + "id": "def-common.kibana.args", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L36" + } + }, + { + "id": "def-common.kibana.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: Input, _: object, { getSearchContext }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_context\", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + } + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": false, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38" + } + }, + { + "type": "Uncategorized", + "label": "_", + "isRequired": true, + "signature": [ + "object" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38" + } + }, + { + "type": "Object", + "label": "{ getSearchContext }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38" + } + } + ], + "description": [], + "label": "kibana", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.kibanaContextFunction", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContextFunction.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L41" + }, + "signature": [ + "\"kibana_context\"" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L42" + }, + "signature": [ + "\"kibana_context\"" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L43" + }, + "signature": [ + "(\"kibana_context\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L44" + } + }, + { + "id": "def-common.kibanaContextFunction.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.kibanaContextFunction.args.q", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.q.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L49" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.q.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L50" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.q.default", + "type": "Uncategorized", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L51" + }, + "signature": [ + "null" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.q.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L52" + } + } + ], + "description": [], + "label": "q", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L48" + } + }, + { + "id": "def-common.kibanaContextFunction.args.filters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.filters.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L57" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.filters.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L58" + } + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.filters.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L59" + } + } + ], + "description": [], + "label": "filters", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L56" + } + }, + { + "id": "def-common.kibanaContextFunction.args.timeRange", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.timeRange.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L64" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.timeRange.default", + "type": "Uncategorized", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L65" + }, + "signature": [ + "null" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.timeRange.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L66" + } + } + ], + "description": [], + "label": "timeRange", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L63" + } + }, + { + "id": "def-common.kibanaContextFunction.args.savedSearchId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.savedSearchId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L71" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.savedSearchId.default", + "type": "Uncategorized", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L72" + }, + "signature": [ + "null" + ] + }, + { + "tags": [], + "id": "def-common.kibanaContextFunction.args.savedSearchId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L73" + } + } + ], + "description": [], + "label": "savedSearchId", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L70" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L47" + } + }, + { + "id": "def-common.kibanaContextFunction.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: Input, args: Arguments, { getSavedObject }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">) => Promise<{ type: \"kibana_context\"; query: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + "[]; filters: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": false, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79" + } + }, + { + "type": "Object", + "label": "{ getSavedObject }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExecutionContextSearch", + "text": "ExecutionContextSearch" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79" + } + } + ], + "description": [], + "label": "kibanaContextFunction", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-common.kibanaContext", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContext.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L30" + } + }, + { + "id": "def-common.kibanaContext.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.kibanaContext.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: string; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L32" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L31" + } + }, + { + "id": "def-common.kibanaContext.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.kibanaContext.to.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: string; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L39" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L38" + } + } + ], + "description": [], + "label": "kibanaContext", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L29" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx new file mode 100644 index 0000000000000..370bd2ffd101e --- /dev/null +++ b/api_docs/data_search.mdx @@ -0,0 +1,61 @@ +--- +id: kibDataSearchPluginApi +slug: /kibana-dev-docs/data.searchPluginApi +title: data.search +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.search plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import dataSearchObj from './data_search.json'; + +## Client + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json new file mode 100644 index 0000000000000..a1514015ac5bc --- /dev/null +++ b/api_docs/data_ui.json @@ -0,0 +1,539 @@ +{ + "id": "data.ui", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.QueryStringInput", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.QueryStringInputProps", + "text": "QueryStringInputProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/index.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.QueryStringInputProps", + "type": "Interface", + "label": "QueryStringInputProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.QueryStringInputProps.indexPatterns", + "type": "Array", + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L42" + }, + "signature": [ + "(string | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ")[]" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L43" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + } + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.disableAutoFocus", + "type": "CompoundType", + "label": "disableAutoFocus", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L44" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.screenTitle", + "type": "string", + "label": "screenTitle", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L45" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.prepend", + "type": "Any", + "label": "prepend", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L46" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.persistedLog", + "type": "Object", + "label": "persistedLog", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L47" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.PersistedLog", + "text": "PersistedLog" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.bubbleSubmitEvent", + "type": "CompoundType", + "label": "bubbleSubmitEvent", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L48" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.placeholder", + "type": "string", + "label": "placeholder", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L49" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.disableLanguageSwitcher", + "type": "CompoundType", + "label": "disableLanguageSwitcher", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L50" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition", + "type": "CompoundType", + "label": "languageSwitcherPopoverAnchorPosition", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L51" + }, + "signature": [ + "\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.onBlur", + "type": "Function", + "label": "onBlur", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L52" + }, + "signature": [ + "(() => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.onChange", + "type": "Function", + "label": "onChange", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L53" + }, + "signature": [ + "((query: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.onChangeQueryInputFocus", + "type": "Function", + "label": "onChangeQueryInputFocus", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L54" + }, + "signature": [ + "((isFocused: boolean) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.onSubmit", + "type": "Function", + "label": "onSubmit", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L55" + }, + "signature": [ + "((query: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.dataTestSubj", + "type": "string", + "label": "dataTestSubj", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L56" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.size", + "type": "CompoundType", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L57" + }, + "signature": [ + "\"s\" | \"l\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L58" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.isInvalid", + "type": "CompoundType", + "label": "isInvalid", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L59" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.isClearable", + "type": "CompoundType", + "label": "isClearable", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L60" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.iconType", + "type": "CompoundType", + "label": "iconType", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L61" + }, + "signature": [ + "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.nonKqlMode", + "type": "CompoundType", + "label": "nonKqlMode", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L67" + }, + "signature": [ + "\"text\" | \"lucene\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStringInputProps.nonKqlModeHelpText", + "type": "string", + "label": "nonKqlModeHelpText", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L68" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L41" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.SearchBar", + "type": "CompoundType", + "label": "SearchBar", + "description": [], + "source": { + "path": "src/plugins/data/public/ui/search_bar/index.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/index.tsx#L23" + }, + "signature": [ + "React.ComponentClass, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SearchBarProps", + "type": "Type", + "label": "SearchBarProps", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/ui/search_bar/search_bar.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/search_bar.tsx#L80" + }, + "signature": [ + "SearchBarOwnProps & SearchBarInjectedDeps" + ], + "initialIsOpen": false + }, + { + "id": "def-public.StatefulSearchBarProps", + "type": "Type", + "label": "StatefulSearchBarProps", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/ui/search_bar/create_search_bar.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/create_search_bar.tsx#L31" + }, + "signature": [ + "SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternSelectProps", + "type": "Type", + "label": "IndexPatternSelectProps", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx#L17" + }, + "signature": [ + "Pick, \"children\" | \"onClick\" | \"color\" | \"id\" | \"title\" | \"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\" | \"onKeyDown\" | \"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\" | \"id\" | \"title\" | \"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\" | \"onKeyDown\" | \"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\" | \"id\" | \"title\" | \"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\" | \"onKeyDown\" | \"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; maxIndexPatterns?: number | undefined; }" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/data_ui.mdx b/api_docs/data_ui.mdx new file mode 100644 index 0000000000000..9eedffdce76f6 --- /dev/null +++ b/api_docs/data_ui.mdx @@ -0,0 +1,24 @@ +--- +id: kibDataUiPluginApi +slug: /kibana-dev-docs/data.uiPluginApi +title: data.ui +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.ui plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.ui'] +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 dataUiObj from './data_ui.json'; + +## Client + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json new file mode 100644 index 0000000000000..2db286ea4d6f9 --- /dev/null +++ b/api_docs/dev_tools.json @@ -0,0 +1,243 @@ +{ + "id": "devTools", + "client": { + "classes": [ + { + "id": "def-public.DevToolsPlugin", + "type": "Class", + "tags": [], + "label": "DevToolsPlugin", + "description": [], + "signature": [ + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.DevToolsPlugin", + "text": "DevToolsPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.DevToolsSetup", + "text": "DevToolsSetup" + }, + ", void, object, object>" + ], + "children": [ + { + "id": "def-public.DevToolsPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(coreSetup: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ", + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.CreateDevToolArgs", + "text": "CreateDevToolArgs" + }, + ") => ", + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.DevToolApp", + "text": "DevToolApp" + }, + "; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "coreSetup", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43" + } + }, + { + "id": "def-public.DevToolsPlugin.setup.{-urlForwarding }", + "type": "Object", + "label": "{ urlForwarding }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.DevToolsPlugin.setup.{-urlForwarding }.urlForwarding", + "type": "Object", + "label": "urlForwarding", + "description": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43" + }, + "signature": [ + "{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }" + ] + } + ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43" + } + }, + { + "id": "def-public.DevToolsPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L84" + } + }, + { + "id": "def-public.DevToolsPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L90" + } + } + ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L35" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.DevToolsSetup", + "type": "Interface", + "label": "DevToolsSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DevToolsSetup.register", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L32" + }, + "signature": [ + "(devTool: ", + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.CreateDevToolArgs", + "text": "CreateDevToolArgs" + }, + ") => ", + { + "pluginId": "devTools", + "scope": "public", + "docId": "kibDevToolsPluginApi", + "section": "def-public.DevToolApp", + "text": "DevToolApp" + } + ] + } + ], + "source": { + "path": "src/plugins/dev_tools/public/plugin.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L21" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx new file mode 100644 index 0000000000000..63abb581b1d3e --- /dev/null +++ b/api_docs/dev_tools.mdx @@ -0,0 +1,21 @@ +--- +id: kibDevToolsPluginApi +slug: /kibana-dev-docs/devToolsPluginApi +title: devTools +image: https://source.unsplash.com/400x175/?github +summary: API docs for the devTools plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import devToolsObj from './dev_tools.json'; + +## Client + +### Setup + + +### Classes + + diff --git a/api_docs/discover.json b/api_docs/discover.json new file mode 100644 index 0000000000000..75396858368b0 --- /dev/null +++ b/api_docs/discover.json @@ -0,0 +1,1153 @@ +{ + "id": "discover", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.createSavedSearchesLoader", + "type": "Function", + "label": "createSavedSearchesLoader", + "signature": [ + "({ savedObjectsClient, savedObjects }: Services) => ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectLoader", + "text": "SavedObjectLoader" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ savedObjectsClient, savedObjects }", + "isRequired": true, + "signature": [ + "Services" + ], + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/saved_searches.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/saved_searches.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.SavedSearch", + "type": "Interface", + "label": "SavedSearch", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedSearch.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.SavedSearch.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.SavedSearch.searchSource", + "type": "Object", + "label": "searchSource", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L17" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.columns", + "type": "Array", + "label": "columns", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L19" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.sort", + "type": "Array", + "label": "sort", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L20" + }, + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SortOrder", + "text": "SortOrder" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.grid", + "type": "Object", + "label": "grid", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L21" + }, + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.DiscoverGridSettings", + "text": "DiscoverGridSettings" + } + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.destroy", + "type": "Function", + "label": "destroy", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L22" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.save", + "type": "Function", + "label": "save", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L23" + }, + "signature": [ + "(saveOptions: ", + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectSaveOpts", + "text": "SavedObjectSaveOpts" + }, + ") => Promise" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.lastSavedTitle", + "type": "string", + "label": "lastSavedTitle", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L24" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.copyOnSave", + "type": "CompoundType", + "label": "copyOnSave", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearch.hideChart", + "type": "CompoundType", + "label": "hideChart", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L26" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedSearchLoader", + "type": "Interface", + "label": "SavedSearchLoader", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedSearchLoader.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L29" + }, + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SavedSearch", + "text": "SavedSearch" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.SavedSearchLoader.urlFor", + "type": "Function", + "label": "urlFor", + "description": [], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L30" + }, + "signature": [ + "(id: string) => string" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/saved_searches/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ISearchEmbeddable", + "type": "Interface", + "label": "ISearchEmbeddable", + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.ISearchEmbeddable", + "text": "ISearchEmbeddable" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SearchInput", + "text": "SearchInput" + }, + ", ", + "SearchOutput", + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.ISearchEmbeddable.getSavedSearch", + "type": "Function", + "label": "getSavedSearch", + "signature": [ + "() => ", + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SavedSearch", + "text": "SavedSearch" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L35" + } + } + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchInput", + "type": "Interface", + "label": "SearchInput", + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SearchInput", + "text": "SearchInput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchInput.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L20" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ] + }, + { + "tags": [], + "id": "def-public.SearchInput.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L21" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchInput.filters", + "type": "Array", + "label": "filters", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L22" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchInput.hidePanelTitles", + "type": "CompoundType", + "label": "hidePanelTitles", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchInput.columns", + "type": "Array", + "label": "columns", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L24" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SearchInput.sort", + "type": "Array", + "label": "sort", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L25" + }, + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SortOrder", + "text": "SortOrder" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DiscoverUrlGeneratorState", + "type": "Interface", + "label": "DiscoverUrlGeneratorState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.savedSearchId", + "type": "string", + "label": "savedSearchId", + "description": [ + "\nOptionally set saved search ID." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.indexPatternId", + "type": "string", + "label": "indexPatternId", + "description": [ + "\nOptionally set index pattern ID." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L31" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.timeRange", + "type": "Object", + "label": "timeRange", + "description": [ + "\nOptionally set the time range in the time picker." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L36" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.refreshInterval", + "type": "Object", + "label": "refreshInterval", + "description": [ + "\nOptionally set the refresh interval." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L41" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.filters", + "type": "Array", + "label": "filters", + "description": [ + "\nOptionally apply filters." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L46" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.query", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L52" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.useHash", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L58" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.searchSessionId", + "type": "string", + "label": "searchSessionId", + "description": [ + "\nBackground search session id" + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.columns", + "type": "Array", + "label": "columns", + "description": [ + "\nColumns displayed in the table" + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L68" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.interval", + "type": "string", + "label": "interval", + "description": [ + "\nUsed interval of the histogram" + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L73" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.sort", + "type": "Array", + "label": "sort", + "description": [ + "\nArray of the used sorting [[field,direction],...]" + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L77" + }, + "signature": [ + "string[][] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.savedQuery", + "type": "string", + "label": "savedQuery", + "description": [ + "\nid of the used saved query" + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L81" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L22" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.SEARCH_EMBEDDABLE_TYPE", + "type": "string", + "label": "SEARCH_EMBEDDABLE_TYPE", + "description": [], + "source": { + "path": "src/plugins/discover/public/application/embeddable/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/constants.ts#L9" + }, + "signature": [ + "\"search\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.DISCOVER_APP_URL_GENERATOR", + "type": "string", + "label": "DISCOVER_APP_URL_GENERATOR", + "description": [], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L20" + }, + "signature": [ + "\"DISCOVER_APP_URL_GENERATOR\"" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.DiscoverSetup", + "type": "Interface", + "label": "DiscoverSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverSetup.docViews", + "type": "Object", + "label": "docViews", + "description": [], + "source": { + "path": "src/plugins/discover/public/plugin.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L75" + }, + "signature": [ + "{ addDocView(docViewRaw: ", + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.DocViewInput", + "text": "DocViewInput" + }, + " | ", + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.DocViewInputFn", + "text": "DocViewInputFn" + }, + "): void; }" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/plugin.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L74" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.DiscoverStart", + "type": "Interface", + "label": "DiscoverStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverStart.savedSearchLoader", + "type": "Object", + "label": "savedSearchLoader", + "description": [], + "source": { + "path": "src/plugins/discover/public/plugin.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L86" + }, + "signature": [ + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectLoader", + "text": "SavedObjectLoader" + } + ] + }, + { + "tags": [], + "id": "def-public.DiscoverStart.urlGenerator", + "type": "Object", + "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.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L104" + }, + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorContract", + "text": "UrlGeneratorContract" + }, + "<\"DISCOVER_APP_URL_GENERATOR\"> | undefined" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/plugin.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L85" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.DEFAULT_COLUMNS_SETTING", + "type": "string", + "label": "DEFAULT_COLUMNS_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L9" + }, + "signature": [ + "\"defaultColumns\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SAMPLE_SIZE_SETTING", + "type": "string", + "label": "SAMPLE_SIZE_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L10" + }, + "signature": [ + "\"discover:sampleSize\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGGS_TERMS_SIZE_SETTING", + "type": "string", + "label": "AGGS_TERMS_SIZE_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L11" + }, + "signature": [ + "\"discover:aggs:terms:size\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SORT_DEFAULT_ORDER_SETTING", + "type": "string", + "label": "SORT_DEFAULT_ORDER_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L12" + }, + "signature": [ + "\"discover:sort:defaultOrder\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING", + "type": "string", + "label": "SEARCH_ON_PAGE_LOAD_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L13" + }, + "signature": [ + "\"discover:searchOnPageLoad\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING", + "type": "string", + "label": "DOC_HIDE_TIME_COLUMN_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L14" + }, + "signature": [ + "\"doc_table:hideTimeColumn\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FIELDS_LIMIT_SETTING", + "type": "string", + "label": "FIELDS_LIMIT_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L15" + }, + "signature": [ + "\"fields:popularLimit\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", + "type": "string", + "label": "CONTEXT_DEFAULT_SIZE_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L16" + }, + "signature": [ + "\"context:defaultSize\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CONTEXT_STEP_SETTING", + "type": "string", + "label": "CONTEXT_STEP_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L17" + }, + "signature": [ + "\"context:step\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING", + "type": "string", + "label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L18" + }, + "signature": [ + "\"context:tieBreakerFields\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DOC_TABLE_LEGACY", + "type": "string", + "label": "DOC_TABLE_LEGACY", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L19" + }, + "signature": [ + "\"doc_table:legacy\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", + "type": "string", + "label": "MODIFY_COLUMNS_ON_SWITCH", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L20" + }, + "signature": [ + "\"discover:modifyColumnsOnSwitch\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SEARCH_FIELDS_FROM_SOURCE", + "type": "string", + "label": "SEARCH_FIELDS_FROM_SOURCE", + "description": [], + "source": { + "path": "src/plugins/discover/common/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L21" + }, + "signature": [ + "\"discover:searchFieldsFromSource\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx new file mode 100644 index 0000000000000..b5f6cefde7cc4 --- /dev/null +++ b/api_docs/discover.mdx @@ -0,0 +1,35 @@ +--- +id: kibDiscoverPluginApi +slug: /kibana-dev-docs/discoverPluginApi +title: discover +image: https://source.unsplash.com/400x175/?github +summary: API docs for the discover plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import discoverObj from './discover.json'; + +## Client + +### Setup + + +### Start + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json new file mode 100644 index 0000000000000..7b4c21d670197 --- /dev/null +++ b/api_docs/discover_enhanced.json @@ -0,0 +1,910 @@ +{ + "id": "discoverEnhanced", + "client": { + "classes": [ + { + "id": "def-public.ExploreDataContextMenuAction", + "type": "Class", + "tags": [], + "label": "ExploreDataContextMenuAction", + "description": [ + "\nThis is \"Explore underlying data\" action which appears in the context\nmenu of a dashboard panel." + ], + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataContextMenuAction", + "text": "ExploreDataContextMenuAction" + }, + " extends ", + "AbstractExploreDataAction", + " implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExploreDataContextMenuAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L37" + }, + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ] + }, + { + "tags": [], + "id": "def-public.ExploreDataContextMenuAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L39" + }, + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ] + }, + { + "tags": [], + "id": "def-public.ExploreDataContextMenuAction.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L41" + }, + "signature": [ + "200" + ] + }, + { + "id": "def-public.ExploreDataContextMenuAction.getUrl", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43" + } + } + ], + "signature": [ + "(context: EmbeddableQueryContext) => Promise<", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.KibanaURL", + "text": "KibanaURL" + }, + ">" + ], + "description": [], + "label": "getUrl", + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExploreDataChartAction", + "type": "Class", + "tags": [], + "label": "ExploreDataChartAction", + "description": [ + "\nThis is \"Explore underlying data\" action which appears in popup context\nmenu when user clicks a value in visualization or brushes a time range." + ], + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartAction", + "text": "ExploreDataChartAction" + }, + " extends ", + "AbstractExploreDataAction", + "<", + "ExploreDataChartActionContext", + "> implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "<", + "ExploreDataChartActionContext" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExploreDataChartAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L35" + }, + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ] + }, + { + "tags": [], + "id": "def-public.ExploreDataChartAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L37" + }, + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ] + }, + { + "tags": [], + "id": "def-public.ExploreDataChartAction.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L39" + }, + "signature": [ + "200" + ] + }, + { + "id": "def-public.ExploreDataChartAction.isCompatible", + "type": "Function", + "label": "isCompatible", + "signature": [ + "(context: ", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" + }, + ") => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41" + } + }, + { + "id": "def-public.ExploreDataChartAction.getUrl", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L47" + } + } + ], + "signature": [ + "(context: ", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" + }, + ") => Promise<", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.KibanaURL", + "text": "KibanaURL" + }, + ">" + ], + "description": [], + "label": "getUrl", + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L46" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DiscoverEnhancedPlugin", + "type": "Class", + "tags": [], + "label": "DiscoverEnhancedPlugin", + "description": [], + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedPlugin", + "text": "DiscoverEnhancedPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverEnhancedPlugin.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L43" + }, + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "common", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-common.Config", + "text": "Config" + } + ] + }, + { + "id": "def-public.DiscoverEnhancedPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45" + } + }, + { + "id": "def-public.DiscoverEnhancedPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" + }, + ", unknown>, { uiActions, share }: ", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedSetupDependencies", + "text": "DiscoverEnhancedSetupDependencies" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" + }, + ", unknown>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L50" + } + }, + { + "type": "Object", + "label": "{ uiActions, share }", + "isRequired": true, + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedSetupDependencies", + "text": "DiscoverEnhancedSetupDependencies" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L51" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L49" + } + }, + { + "id": "def-public.DiscoverEnhancedPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: ", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" + }, + ") => void" + ], + "description": [], + "children": [ + { + "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/discover_enhanced/public/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69" + } + }, + { + "type": "Object", + "label": "plugins", + "isRequired": true, + "signature": [ + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69" + } + }, + { + "id": "def-public.DiscoverEnhancedPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L71" + } + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L40" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.DiscoverEnhancedSetupDependencies", + "type": "Interface", + "label": "DiscoverEnhancedSetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverEnhancedSetupDependencies.discover", + "type": "Object", + "label": "discover", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L25" + }, + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.DiscoverSetup", + "text": "DiscoverSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedSetupDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L26" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableSetup", + "text": "EmbeddableSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy", + "type": "Object", + "label": "kibanaLegacy", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L27" + }, + "signature": [ + "{} | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedSetupDependencies.share", + "type": "CompoundType", + "label": "share", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L28" + }, + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.SharePluginSetup", + "text": "SharePluginSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedSetupDependencies.uiActions", + "type": "Object", + "label": "uiActions", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L29" + }, + "signature": [ + "Pick<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" + ] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DiscoverEnhancedStartDependencies", + "type": "Interface", + "label": "DiscoverEnhancedStartDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DiscoverEnhancedStartDependencies.discover", + "type": "Object", + "label": "discover", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L33" + }, + "signature": [ + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.DiscoverStart", + "text": "DiscoverStart" + } + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedStartDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L34" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStart", + "text": "EmbeddableStart" + } + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedStartDependencies.kibanaLegacy", + "type": "Object", + "label": "kibanaLegacy", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L35" + }, + "signature": [ + "{ dashboardConfig: ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.DashboardConfig", + "text": "DashboardConfig" + }, + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedStartDependencies.share", + "type": "CompoundType", + "label": "share", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L36" + }, + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.SharePluginStart", + "text": "SharePluginStart" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverEnhancedStartDependencies.uiActions", + "type": "Object", + "label": "uiActions", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L37" + }, + "signature": [ + "Pick<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ", ", + "MethodKeysOf", + "<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ">>" + ] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L32" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-common.Config", + "type": "Interface", + "label": "Config", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Config.actions", + "type": "Object", + "label": "actions", + "description": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/common/config.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L9" + }, + "signature": [ + "{ exploreDataInChart: { enabled: boolean; }; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/common/config.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L8" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx new file mode 100644 index 0000000000000..06037e1190c0d --- /dev/null +++ b/api_docs/discover_enhanced.mdx @@ -0,0 +1,26 @@ +--- +id: kibDiscoverEnhancedPluginApi +slug: /kibana-dev-docs/discoverEnhancedPluginApi +title: discoverEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the discoverEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import discoverEnhancedObj from './discover_enhanced.json'; + +## Client + +### Classes + + +### Interfaces + + +## Common + +### Interfaces + + diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json new file mode 100644 index 0000000000000..2b10b5ffa08cc --- /dev/null +++ b/api_docs/embeddable.json @@ -0,0 +1,9507 @@ +{ + "id": "embeddable", + "client": { + "classes": [ + { + "id": "def-public.AddPanelAction", + "type": "Class", + "tags": [], + "label": "AddPanelAction", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.AddPanelAction", + "text": "AddPanelAction" + }, + " implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.AddPanelAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L24" + }, + "signature": [ + "\"ACTION_ADD_PANEL\"" + ] + }, + { + "tags": [], + "id": "def-public.AddPanelAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L25" + }, + "signature": [ + "\"ACTION_ADD_PANEL\"" + ] + }, + { + "id": "def-public.AddPanelAction.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getFactory", + "isRequired": true, + "signature": [ + " IterableIterator<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L29" + } + }, + { + "type": "Object", + "label": "overlays", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayStart", + "text": "OverlayStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L30" + } + }, + { + "type": "Object", + "label": "notifications", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L31" + } + }, + { + "type": "CompoundType", + "label": "SavedObjectFinder", + "isRequired": true, + "signature": [ + "React.ComponentType" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L32" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L27" + } + }, + { + "id": "def-public.AddPanelAction.getDisplayName", + "type": "Function", + "label": "getDisplayName", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L35" + } + }, + { + "id": "def-public.AddPanelAction.getIconType", + "type": "Function", + "label": "getIconType", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L41" + } + }, + { + "id": "def-public.AddPanelAction.isCompatible", + "type": "Function", + "label": "isCompatible", + "signature": [ + "(context: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionExecutionContext", + "text": "ActionExecutionContext" + }, + ") => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionExecutionContext", + "text": "ActionExecutionContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L45" + } + }, + { + "id": "def-public.AddPanelAction.execute", + "type": "Function", + "label": "execute", + "signature": [ + "(context: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionExecutionContext", + "text": "ActionExecutionContext" + }, + ") => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionExecutionContext", + "text": "ActionExecutionContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L50" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L50" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Container", + "type": "Class", + "tags": [], + "label": "Container", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Container", + "text": "Container" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.Container.isContainer", + "type": "boolean", + "label": "isContainer", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L34" + } + }, + { + "id": "def-public.Container.children", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "children", + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L35" + } + }, + { + "id": "def-public.Container.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "TContainerInput" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L42" + } + }, + { + "type": "Uncategorized", + "label": "output", + "isRequired": true, + "signature": [ + "TContainerOutput" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L43" + } + }, + { + "type": "Function", + "label": "getFactory", + "isRequired": true, + "signature": [ + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L41" + } + }, + { + "id": "def-public.Container.updateInputForChild", + "type": "Function", + "label": "updateInputForChild", + "signature": [ + "(id: string, changes: Partial) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L57" + } + }, + { + "type": "Object", + "label": "changes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L58" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L56" + } + }, + { + "id": "def-public.Container.reload", + "type": "Function", + "label": "reload", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L78" + } + }, + { + "id": "def-public.Container.addNewEmbeddable", + "type": "Function", + "label": "addNewEmbeddable", + "signature": [ + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L82" + } + }, + { + "id": "def-public.Container.removeEmbeddable", + "type": "Function", + "label": "removeEmbeddable", + "signature": [ + "(embeddableId: string) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "embeddableId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L98" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L98" + } + }, + { + "id": "def-public.Container.getChildIds", + "type": "Function", + "label": "getChildIds", + "signature": [ + "() => string[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L106" + } + }, + { + "id": "def-public.Container.getChild", + "type": "Function", + "label": "getChild", + "signature": [ + ">(id: string) => E" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L110" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L110" + } + }, + { + "id": "def-public.Container.getInputForChild", + "type": "Function", + "label": "getInputForChild", + "signature": [ + "(embeddableId: string) => TEmbeddableInput" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "embeddableId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L115" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L114" + } + }, + { + "id": "def-public.Container.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L146" + } + }, + { + "id": "def-public.Container.untilEmbeddableLoaded", + "type": "Function", + "label": "untilEmbeddableLoaded", + "signature": [ + ">(id: string) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable>" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L153" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L152" + } + }, + { + "id": "def-public.Container.createNewPanelState", + "type": "Function", + "label": "createNewPanelState", + "signature": [ + ">(factory: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + ", partial?: Partial) => ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "factory", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L184" + } + }, + { + "type": "Object", + "label": "partial", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L185" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L180" + } + }, + { + "id": "def-public.Container.getPanelState", + "type": "Function", + "label": "getPanelState", + "signature": [ + "(embeddableId: string) => ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "embeddableId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L205" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L204" + } + }, + { + "id": "def-public.Container.getInheritedInput", + "type": "Function", + "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": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L219" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L219" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EditPanelAction", + "type": "Class", + "tags": [], + "label": "EditPanelAction", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EditPanelAction", + "text": "EditPanelAction" + }, + " implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.EditPanelAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L38" + }, + "signature": [ + "\"editPanel\"" + ] + }, + { + "tags": [], + "id": "def-public.EditPanelAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L39" + }, + "signature": [ + "\"editPanel\"" + ] + }, + { + "tags": [], + "id": "def-public.EditPanelAction.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L40" + } + }, + { + "tags": [], + "id": "def-public.EditPanelAction.currentAppId", + "type": "string", + "label": "currentAppId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L41" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.EditPanelAction.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getEmbeddableFactory", + "isRequired": true, + "signature": [ + " string" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L55" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L55" + } + }, + { + "id": "def-public.EditPanelAction.getIconType", + "type": "Function", + "label": "getIconType", + "signature": [ + "() => string" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L68" + } + }, + { + "id": "def-public.EditPanelAction.isCompatible", + "type": "Function", + "label": "isCompatible", + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L72" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L72" + } + }, + { + "id": "def-public.EditPanelAction.execute", + "type": "Function", + "label": "execute", + "signature": [ + "(context: ActionContext) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L83" + } + }, + { + "id": "def-public.EditPanelAction.getAppTarget", + "type": "Function", + "label": "getAppTarget", + "signature": [ + "({ embeddable }: ActionContext) => NavigationContext | undefined" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L104" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L104" + } + }, + { + "id": "def-public.EditPanelAction.getHref", + "type": "Function", + "label": "getHref", + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L121" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L121" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Embeddable", + "type": "Class", + "tags": [], + "label": "Embeddable", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.Embeddable.runtimeId", + "type": "number", + "label": "runtimeId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L27" + } + }, + { + "tags": [], + "id": "def-public.Embeddable.runtimeId", + "type": "number", + "label": "runtimeId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L29" + } + }, + { + "tags": [], + "id": "def-public.Embeddable.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L31" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ] + }, + { + "tags": [], + "id": "def-public.Embeddable.isContainer", + "type": "boolean", + "label": "isContainer", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L32" + } + }, + { + "tags": [], + "id": "def-public.Embeddable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L33" + } + }, + { + "tags": [], + "id": "def-public.Embeddable.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L34" + } + }, + { + "tags": [], + "id": "def-public.Embeddable.fatalError", + "type": "Object", + "label": "fatalError", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L35" + }, + "signature": [ + "Error | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Embeddable.output", + "type": "Uncategorized", + "label": "output", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L37" + }, + "signature": [ + "TEmbeddableOutput" + ] + }, + { + "tags": [], + "id": "def-public.Embeddable.input", + "type": "Uncategorized", + "label": "input", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L38" + }, + "signature": [ + "TEmbeddableInput" + ] + }, + { + "tags": [], + "id": "def-public.Embeddable.renderComplete", + "type": "Object", + "label": "renderComplete", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L43" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.RenderCompleteDispatcher", + "text": "RenderCompleteDispatcher" + } + ] + }, + { + "id": "def-public.Embeddable.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "TEmbeddableInput" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51" + } + }, + { + "type": "Uncategorized", + "label": "output", + "isRequired": true, + "signature": [ + "TEmbeddableOutput" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51" + } + }, + { + "id": "def-public.Embeddable.getIsContainer", + "type": "Function", + "label": "getIsContainer", + "signature": [ + "() => this is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L89" + } + }, + { + "id": "def-public.Embeddable.reload", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L106" + } + }, + { + "id": "def-public.Embeddable.getUpdated$", + "type": "Function", + "label": "getUpdated$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L114" + } + }, + { + "id": "def-public.Embeddable.getInput$", + "type": "Function", + "label": "getInput$", + "signature": [ + "() => Readonly<", + "Observable", + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L121" + } + }, + { + "id": "def-public.Embeddable.getOutput$", + "type": "Function", + "label": "getOutput$", + "signature": [ + "() => Readonly<", + "Observable", + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L125" + } + }, + { + "id": "def-public.Embeddable.getOutput", + "type": "Function", + "label": "getOutput", + "signature": [ + "() => Readonly" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L129" + } + }, + { + "id": "def-public.Embeddable.getInput", + "type": "Function", + "label": "getInput", + "signature": [ + "() => Readonly" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L133" + } + }, + { + "id": "def-public.Embeddable.getTitle", + "type": "Function", + "label": "getTitle", + "signature": [ + "() => string" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L137" + } + }, + { + "id": "def-public.Embeddable.getRoot", + "type": "Function", + "label": "getRoot", + "signature": [ + "() => ", + { + "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" + }, + "> | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "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": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L145" + } + }, + { + "id": "def-public.Embeddable.updateInput", + "type": "Function", + "label": "updateInput", + "signature": [ + "(changes: Partial) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "changes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L153" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L153" + } + }, + { + "id": "def-public.Embeddable.render", + "type": "Function", + "label": "render", + "signature": [ + "(el: HTMLElement) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "el", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L165" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L165" + } + }, + { + "id": "def-public.Embeddable.getInspectorAdapters", + "type": "Function", + "label": "getInspectorAdapters", + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | 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": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L180" + } + }, + { + "id": "def-public.Embeddable.destroy", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L188" + } + }, + { + "id": "def-public.Embeddable.updateOutput", + "type": "Function", + "label": "updateOutput", + "signature": [ + "(outputChanges: Partial) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "outputChanges", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L200" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L200" + } + }, + { + "id": "def-public.Embeddable.onFatalError", + "type": "Function", + "label": "onFatalError", + "signature": [ + "(e: Error) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "e", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L211" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L211" + } + }, + { + "id": "def-public.Embeddable.supportedTriggers", + "type": "Function", + "label": "supportedTriggers", + "signature": [ + "() => string[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L239" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableChildPanel", + "type": "Class", + "tags": [], + "label": "EmbeddableChildPanel", + "description": [ + "\nThis component can be used by embeddable containers using react to easily render children. It waits\nfor the child to be initialized, showing a loading indicator until that is complete." + ], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableChildPanel", + "text": "EmbeddableChildPanel" + }, + " extends React.Component<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableChildPanelProps", + "text": "EmbeddableChildPanelProps" + }, + ", State, any>" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableChildPanel.mounted", + "type": "boolean", + "label": "mounted", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L36" + } + }, + { + "tags": [], + "id": "def-public.EmbeddableChildPanel.embeddable", + "type": "CompoundType", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L37" + }, + "signature": [ + { + "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" + }, + "> | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + } + ] + }, + { + "id": "def-public.EmbeddableChildPanel.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableChildPanelProps", + "text": "EmbeddableChildPanelProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L40" + } + }, + { + "id": "def-public.EmbeddableChildPanel.componentDidMount", + "type": "Function", + "label": "componentDidMount", + "signature": [ + "() => Promise" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L49" + } + }, + { + "id": "def-public.EmbeddableChildPanel.componentWillUnmount", + "type": "Function", + "label": "componentWillUnmount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L59" + } + }, + { + "id": "def-public.EmbeddableChildPanel.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L66" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableFactoryNotFoundError", + "type": "Class", + "tags": [], + "label": "EmbeddableFactoryNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryNotFoundError", + "text": "EmbeddableFactoryNotFoundError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableFactoryNotFoundError.code", + "type": "string", + "label": "code", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L25" + } + }, + { + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L27" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L27" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddablePanel", + "type": "Class", + "tags": [], + "label": "EmbeddablePanel", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePanel", + "text": "EmbeddablePanel" + }, + " extends React.Component" + ], + "children": [ + { + "id": "def-public.EmbeddablePanel.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L96" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L96" + } + }, + { + "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", + "type": "Function", + "label": "UNSAFE_componentWillMount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L153" + } + }, + { + "id": "def-public.EmbeddablePanel.componentWillUnmount", + "type": "Function", + "label": "componentWillUnmount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L187" + } + }, + { + "id": "def-public.EmbeddablePanel.onFocus", + "type": "Function", + "children": [ + { + "type": "string", + "label": "focusedPanelIndex", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L199" + } + } + ], + "signature": [ + "(focusedPanelIndex: string) => void" + ], + "description": [], + "label": "onFocus", + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L199" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.EmbeddablePanel.onBlur", + "type": "Function", + "children": [ + { + "type": "string", + "label": "blurredPanelIndex", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L203" + } + } + ], + "signature": [ + "(blurredPanelIndex: string) => void" + ], + "description": [], + "label": "onBlur", + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 203, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L203" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.EmbeddablePanel.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L209" + } + }, + { + "id": "def-public.EmbeddablePanel.componentDidMount", + "type": "Function", + "label": "componentDidMount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L251" + } + }, + { + "id": "def-public.EmbeddablePanel.closeMyContextMenuPanel", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "closeMyContextMenuPanel", + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 274, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L274" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableRoot", + "type": "Class", + "tags": [], + "label": "EmbeddableRoot", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRoot", + "text": "EmbeddableRoot" + }, + " extends React.Component" + ], + "children": [ + { + "id": "def-public.EmbeddableRoot.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L25" + } + }, + { + "id": "def-public.EmbeddableRoot.componentDidMount", + "type": "Function", + "label": "componentDidMount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L31" + } + }, + { + "id": "def-public.EmbeddableRoot.componentDidUpdate", + "type": "Function", + "label": "componentDidUpdate", + "signature": [ + "(prevProps?: Props | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "prevProps", + "isRequired": false, + "signature": [ + "Props | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L38" + } + }, + { + "id": "def-public.EmbeddableRoot.shouldComponentUpdate", + "type": "Function", + "label": "shouldComponentUpdate", + "signature": [ + "(newProps: Props) => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "newProps", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L59" + } + }, + { + "id": "def-public.EmbeddableRoot.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L69" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ErrorEmbeddable", + "type": "Class", + "tags": [], + "label": "ErrorEmbeddable", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-public.ErrorEmbeddable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L26" + }, + "signature": [ + "\"error\"" + ] + }, + { + "tags": [], + "id": "def-public.ErrorEmbeddable.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L27" + }, + "signature": [ + "string | Error" + ] + }, + { + "id": "def-public.ErrorEmbeddable.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30" + } + }, + { + "type": "Object", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30" + } + }, + { + "id": "def-public.ErrorEmbeddable.reload", + "type": "Function", + "label": "reload", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L35" + } + }, + { + "id": "def-public.ErrorEmbeddable.render", + "type": "Function", + "label": "render", + "signature": [ + "(dom: HTMLElement) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "dom", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L37" + } + }, + { + "id": "def-public.ErrorEmbeddable.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L57" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PanelNotFoundError", + "type": "Class", + "tags": [], + "label": "PanelNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.PanelNotFoundError", + "text": "PanelNotFoundError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-public.PanelNotFoundError.code", + "type": "string", + "label": "code", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L13" + } + }, + { + "id": "def-public.PanelNotFoundError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L15" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableStateTransfer", + "type": "Class", + "tags": [ + "public" + ], + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.isTransferInProgress", + "type": "boolean", + "label": "isTransferInProgress", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L30" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "navigateToApp", + "isRequired": true, + "signature": [ + "(appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined) => Promise" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L34" + } + }, + { + "type": "Object", + "label": "currentAppId$", + "isRequired": true, + "signature": [ + "Observable", + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L35" + } + }, + { + "type": "Object", + "label": "appList", + "isRequired": false, + "signature": [ + "ReadonlyMap | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L36" + } + }, + { + "type": "Object", + "label": "customStorage", + "isRequired": false, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.Storage", + "text": "Storage" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L33" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.getAppNameFromId", + "type": "Function", + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L50" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L50" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState", + "type": "Function", + "label": "getIncomingEditorState", + "signature": [ + "(appId: string, removeAfterFetch?: boolean | undefined) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableEditorState", + "text": "EmbeddableEditorState" + }, + " | undefined" + ], + "description": [ + "\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The app to fetch incomingEditorState for" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L59" + } + }, + { + "type": "CompoundType", + "label": "removeAfterFetch", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [ + "- Whether to remove the package state after fetch to prevent duplicates." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L60" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L58" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.clearEditorState", + "type": "Function", + "label": "clearEditorState", + "signature": [ + "(appId?: string | undefined) => void" + ], + "description": [ + "\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "- The app to fetch incomingEditorState for" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L78" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L78" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage", + "type": "Function", + "label": "getIncomingEmbeddablePackage", + "signature": [ + "(appId: string, removeAfterFetch?: boolean | undefined) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePackageState", + "text": "EmbeddablePackageState" + }, + " | undefined" + ], + "description": [ + "\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- The app to fetch EmbeddablePackageState for" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L97" + } + }, + { + "type": "CompoundType", + "label": "removeAfterFetch", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [ + "- Whether to remove the package state after fetch to prevent duplicates." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L98" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L96" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.navigateToEditor", + "type": "Function", + "label": "navigateToEditor", + "signature": [ + "(appId: string, options?: { path?: string | undefined; state: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableEditorState", + "text": "EmbeddableEditorState" + }, + "; } | undefined) => Promise" + ], + "description": [ + "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L115" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L117" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L118" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableEditorState", + "text": "EmbeddableEditorState" + } + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L116" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L114" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage", + "type": "Function", + "label": "navigateToWithEmbeddablePackage", + "signature": [ + "(appId: string, options?: { path?: string | undefined; state: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePackageState", + "text": "EmbeddablePackageState" + }, + "; } | undefined) => Promise" + ], + "description": [ + "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}" + ], + "children": [ + { + "type": "string", + "label": "appId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L132" + } + }, + { + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePackageState", + "text": "EmbeddablePackageState" + } + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L131" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AttributeService", + "type": "Class", + "tags": [], + "label": "AttributeService", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.AttributeService", + "text": "AttributeService" + }, + "" + ], + "children": [ + { + "id": "def-public.AttributeService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L49" + } + }, + { + "type": "Function", + "label": "showSaveModal", + "isRequired": true, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L50" + } + }, + { + "type": "Function", + "label": "i18nContext", + "isRequired": true, + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L54" + } + }, + { + "type": "Object", + "label": "toasts", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L55" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.AttributeServiceOptions", + "text": "AttributeServiceOptions" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L56" + } + }, + { + "type": "Function", + "label": "getEmbeddableFactory", + "isRequired": false, + "signature": [ + "((embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L48" + } + }, + { + "id": "def-public.AttributeService.unwrapAttributes", + "type": "Function", + "label": "unwrapAttributes", + "signature": [ + "(input: ValType | RefType) => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + "ValType | RefType" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L74" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L74" + } + }, + { + "id": "def-public.AttributeService.wrapAttributes", + "type": "Function", + "label": "wrapAttributes", + "signature": [ + "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "newAttributes", + "isRequired": true, + "signature": [ + "SavedObjectAttributes" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L84" + } + }, + { + "type": "boolean", + "label": "useRefType", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L85" + } + }, + { + "type": "CompoundType", + "label": "input", + "isRequired": false, + "signature": [ + "ValType | RefType | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L83" + } + }, + { + "id": "def-public.AttributeService.inputIsRefType", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + "ValType | RefType" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L116" + } + } + ], + "signature": [ + "(input: ValType | RefType) => input is RefType" + ], + "description": [], + "label": "inputIsRefType", + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L116" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AttributeService.getExplicitInputFromEmbeddable", + "type": "Function", + "label": "getExplicitInputFromEmbeddable", + "signature": [ + "(embeddable: ", + { + "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" + }, + ">) => ValType | RefType" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "embeddable", + "isRequired": true, + "signature": [ + { + "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/attribute_service/attribute_service.tsx", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L120" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L120" + } + }, + { + "id": "def-public.AttributeService.getInputAsValueType", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + "ValType | RefType" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L125" + } + } + ], + "signature": [ + "(input: ValType | RefType) => Promise" + ], + "description": [], + "label": "getInputAsValueType", + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L125" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.AttributeService.getInputAsRefType", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + "ValType | RefType" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L138" + } + }, + { + "type": "CompoundType", + "label": "saveOptions", + "isRequired": false, + "signature": [ + "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L139" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L137" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L41" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.isReferenceOrValueEmbeddable", + "type": "Function", + "label": "isReferenceOrValueEmbeddable", + "signature": [ + "(incoming: unknown) => boolean" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "incoming", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.defaultEmbeddableFactoryProvider", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#L22" + } + } + ], + "signature": [ + " x is ", + { + "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": [], + "label": "isEmbeddable", + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/is_embeddable.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isErrorEmbeddable", + "type": "Function", + "label": "isErrorEmbeddable", + "signature": [ + "(embeddable: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable) => boolean" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "embeddable", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.openAddPanelFlyout", + "type": "Function", + "label": "openAddPanelFlyout", + "signature": [ + "(options: { embeddable: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">; getFactory: , ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.openAddPanelFlyout.options.getFactory", + "type": "Function", + "label": "getFactory", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L18" + }, + "signature": [ + " IterableIterator<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ] + }, + { + "tags": [], + "id": "def-public.openAddPanelFlyout.options.overlays", + "type": "Object", + "label": "overlays", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L20" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayStart", + "text": "OverlayStart" + } + ] + }, + { + "tags": [], + "id": "def-public.openAddPanelFlyout.options.notifications", + "type": "Object", + "label": "notifications", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L21" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } + ] + }, + { + "tags": [], + "id": "def-public.openAddPanelFlyout.options.SavedObjectFinder", + "type": "CompoundType", + "label": "SavedObjectFinder", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L22" + }, + "signature": [ + "React.ComponentType" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.withEmbeddableSubscription", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/with_subscription.tsx#L19" + } + } + ], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ", 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/with_subscription.tsx#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isSavedObjectEmbeddableInput", + "type": "Function", + "label": "isSavedObjectEmbeddableInput", + "signature": [ + "(input: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + }, + ") => boolean" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.isRangeSelectTriggerContext", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L107" + } + } + ], + "signature": [ + "(context: ", + { + "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" + }, + ">>) => context is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" + } + ], + "description": [], + "label": "isRangeSelectTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L106" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isValueClickTriggerContext", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L103" + } + } + ], + "signature": [ + "(context: ", + { + "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" + }, + ">>) => context is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + } + ], + "description": [], + "label": "isValueClickTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L102" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isRowClickTriggerContext", + "type": "Function", + "children": [ + { + "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": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L110" + } + } + ], + "signature": [ + "(context: ", + { + "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" + }, + ">>) => context is ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.RowClickContext", + "text": "RowClickContext" + } + ], + "description": [], + "label": "isRowClickTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L110" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isContextMenuTriggerContext", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "context", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L115" + } + } + ], + "signature": [ + "(context: unknown) => context is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableContext", + "text": "EmbeddableContext" + }, + "<", + { + "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": [], + "label": "isContextMenuTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L115" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableRenderer", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L83" + } + } + ], + "signature": [ + "(props: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" + }, + ") => 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L82" + }, + "tags": [ + "remarks", + "public" + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.Adapters", + "type": "Interface", + "label": "Adapters", + "description": [ + "\nThe interface that the adapters used to open an inspector have to fullfill." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Adapters.requests", + "type": "Object", + "label": "requests", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ] + }, + { + "id": "def-public.Adapters.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ReferenceOrValueEmbeddable", + "type": "Interface", + "label": "ReferenceOrValueEmbeddable", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ReferenceOrValueEmbeddable", + "text": "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)." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType", + "type": "Function", + "label": "inputIsRefType", + "description": [ + "\ndetermines whether the input is by value or by reference." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L24" + }, + "signature": [ + "(input: ValTypeInput | RefTypeInput) => input is RefTypeInput" + ] + }, + { + "tags": [], + "id": "def-public.ReferenceOrValueEmbeddable.getInputAsValueType", + "type": "Function", + "label": "getInputAsValueType", + "description": [ + "\nGets the embeddable's current input as its Value type" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L29" + }, + "signature": [ + "() => Promise" + ] + }, + { + "tags": [], + "id": "def-public.ReferenceOrValueEmbeddable.getInputAsRefType", + "type": "Function", + "label": "getInputAsRefType", + "description": [ + "\nGets the embeddable's current input as its Reference type" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L34" + }, + "signature": [ + "() => Promise" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ContainerInput", + "type": "Interface", + "label": "ContainerInput", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ContainerInput.hidePanelTitles", + "type": "CompoundType", + "label": "hidePanelTitles", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L25" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ContainerInput.panels", + "type": "Object", + "label": "panels", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L26" + }, + "signature": [ + "{ [key: string]: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "; }" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ContainerOutput", + "type": "Interface", + "label": "ContainerOutput", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ContainerOutput.embeddableLoaded", + "type": "Object", + "label": "embeddableLoaded", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L21" + }, + "signature": [ + "{ [key: string]: boolean; }" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableChildPanelProps", + "type": "Interface", + "label": "EmbeddableChildPanelProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableChildPanelProps.embeddableId", + "type": "string", + "label": "embeddableId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L19" + } + }, + { + "tags": [], + "id": "def-public.EmbeddableChildPanelProps.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableChildPanelProps.container", + "type": "Object", + "label": "container", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L21" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableChildPanelProps.PanelComponent", + "type": "Function", + "label": "PanelComponent", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L22" + }, + "signature": [ + "React.FC<{ embeddable: ", + { + "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" + }, + ">; hideHeader?: boolean | undefined; }>" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableContext", + "type": "Interface", + "label": "EmbeddableContext", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableContext", + "text": "EmbeddableContext" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableContext.embeddable", + "type": "Uncategorized", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L15" + }, + "signature": [ + "T" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableFactory", + "type": "Interface", + "label": "EmbeddableFactory", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" + ], + "description": [ + "\nEmbeddableFactories create and initialize an embeddable instance" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableFactory.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L41" + } + }, + { + "tags": [], + "id": "def-public.EmbeddableFactory.isEditable", + "type": "Function", + "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." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L47" + }, + "signature": [ + "() => Promise" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableFactory.savedObjectMetaData", + "type": "Object", + "label": "savedObjectMetaData", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L49" + }, + "signature": [ + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObjectMetaData", + "text": "SavedObjectMetaData" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableFactory.isContainerType", + "type": "boolean", + "label": "isContainerType", + "description": [ + "\nTrue if is this factory create embeddables that are Containers. Used in the add panel to\nconditionally show whether these can be added to another container. It's just not\nsupported right now, but once nested containers are officially supported we can probably get\nrid of this interface." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L57" + } + }, + { + "id": "def-public.EmbeddableFactory.getDisplayName", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L63" + } + }, + { + "id": "def-public.EmbeddableFactory.canCreateNew", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L69" + } + }, + { + "id": "def-public.EmbeddableFactory.getDefaultInput", + "type": "Function", + "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." + ], + "children": [ + { + "type": "Object", + "label": "partial", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L77" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L77" + } + }, + { + "id": "def-public.EmbeddableFactory.getExplicitInput", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L84" + } + }, + { + "id": "def-public.EmbeddableFactory.createFromSavedObject", + "type": "Function", + "label": "createFromSavedObject", + "signature": [ + "(savedObjectId: string, input: Partial, parent?: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "description": [ + "\nCreates a new embeddable instance based off the saved object id." + ], + "children": [ + { + "type": "string", + "label": "savedObjectId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L94" + } + }, + { + "type": "Object", + "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." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L95" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L96" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L93" + } + }, + { + "id": "def-public.EmbeddableFactory.create", + "type": "Function", + "label": "create", + "signature": [ + "(initialInput: TEmbeddableInput, parent?: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "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." + ], + "children": [ + { + "type": "Uncategorized", + "label": "initialInput", + "isRequired": true, + "signature": [ + "TEmbeddableInput" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L106" + } + }, + { + "type": "Object", + "label": "parent", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L107" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L105" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableInstanceConfiguration", + "type": "Interface", + "label": "EmbeddableInstanceConfiguration", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableInstanceConfiguration.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.EmbeddableInstanceConfiguration.savedObjectId", + "type": "string", + "label": "savedObjectId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L20" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableOutput", + "type": "Interface", + "label": "EmbeddableOutput", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableOutput.loading", + "type": "CompoundType", + "label": "loading", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L23" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L25" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableError", + "text": "EmbeddableError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.editUrl", + "type": "string", + "label": "editUrl", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.editApp", + "type": "string", + "label": "editApp", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.editPath", + "type": "string", + "label": "editPath", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L28" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.defaultTitle", + "type": "string", + "label": "defaultTitle", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L29" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L30" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.editable", + "type": "CompoundType", + "label": "editable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L31" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableOutput.savedObjectId", + "type": "string", + "label": "savedObjectId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L32" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ValueClickContext", + "type": "Interface", + "label": "ValueClickContext", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ValueClickContext.embeddable", + "type": "Uncategorized", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L19" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ValueClickContext.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L20" + }, + "signature": [ + "{ data: { table: Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "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": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RangeSelectContext", + "type": "Interface", + "label": "RangeSelectContext", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RangeSelectContext.embeddable", + "type": "Uncategorized", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L33" + }, + "signature": [ + "T | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RangeSelectContext.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L34" + }, + "signature": [ + "{ table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; column: number; range: number[]; timeFieldName?: string | undefined; }" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IContainer", + "type": "Interface", + "label": "IContainer", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.IContainer.untilEmbeddableLoaded", + "type": "Function", + "label": "untilEmbeddableLoaded", + "signature": [ + ">(id: string) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable>" + ], + "description": [ + "\nCall if you want to wait until an embeddable with that id has finished loading." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L39" + } + }, + { + "id": "def-public.IContainer.getInputForChild", + "type": "Function", + "label": "getInputForChild", + "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." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L49" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L49" + } + }, + { + "id": "def-public.IContainer.updateInputForChild", + "type": "Function", + "label": "updateInputForChild", + "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." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57" + } + }, + { + "type": "Object", + "label": "changes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57" + } + }, + { + "id": "def-public.IContainer.getChild", + "type": "Function", + "label": "getChild", + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [ + "\nReturns the child embeddable with the given id." + ], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L63" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L63" + } + }, + { + "id": "def-public.IContainer.removeEmbeddable", + "type": "Function", + "label": "removeEmbeddable", + "signature": [ + "(embeddableId: string) => void" + ], + "description": [ + "\nRemoves the embeddable with the given id." + ], + "children": [ + { + "type": "string", + "label": "embeddableId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L69" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L69" + } + }, + { + "id": "def-public.IContainer.addNewEmbeddable", + "type": "Function", + "label": "addNewEmbeddable", + "signature": [ + "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L81" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L75" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IEmbeddable", + "type": "Interface", + "label": "IEmbeddable", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IEmbeddable.isContainer", + "type": "boolean", + "label": "isContainer", + "description": [ + "\nIs this embeddable an instance of a Container class, can it contain\nnested embeddables?" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L43" + } + }, + { + "tags": [], + "id": "def-public.IEmbeddable.parent", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L49" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "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" + ] + }, + { + "tags": [], + "id": "def-public.IEmbeddable.type", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L55" + } + }, + { + "tags": [], + "id": "def-public.IEmbeddable.id", + "type": "string", + "label": "id", + "description": [ + "\nA unique identifier for this embeddable. Mainly only used by containers to map their\nPanel States to a child embeddable instance." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L61" + } + }, + { + "tags": [], + "id": "def-public.IEmbeddable.runtimeId", + "type": "number", + "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`." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L69" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IEmbeddable.enhancements", + "type": "Uncategorized", + "label": "enhancements", + "description": [ + "\nExtra abilities added to Embeddable by `*_enhanced` plugins." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L74" + }, + "signature": [ + "object | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IEmbeddable.fatalError", + "type": "Object", + "label": "fatalError", + "description": [ + "\nIf this embeddable has encountered a fatal error, that error will be stored here" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L79" + }, + "signature": [ + "Error | undefined" + ] + }, + { + "id": "def-public.IEmbeddable.getIsContainer", + "type": "Function", + "label": "getIsContainer", + "signature": [ + "() => this is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L85" + } + }, + { + "id": "def-public.IEmbeddable.getInput", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L96" + } + }, + { + "id": "def-public.IEmbeddable.getOutput", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L108" + } + }, + { + "id": "def-public.IEmbeddable.updateInput", + "type": "Function", + "label": "updateInput", + "signature": [ + "(changes: Partial) => void" + ], + "description": [ + "\nUpdates input state with the given changes." + ], + "children": [ + { + "type": "Object", + "label": "changes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L114" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L114" + } + }, + { + "id": "def-public.IEmbeddable.getInput$", + "type": "Function", + "label": "getInput$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L119" + } + }, + { + "id": "def-public.IEmbeddable.getOutput$", + "type": "Function", + "label": "getOutput$", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L124" + } + }, + { + "id": "def-public.IEmbeddable.getTitle", + "type": "Function", + "label": "getTitle", + "signature": [ + "() => string | undefined" + ], + "description": [ + "\nReturns the title of this embeddable." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L129" + } + }, + { + "id": "def-public.IEmbeddable.getRoot", + "type": "Function", + "label": "getRoot", + "signature": [ + "() => ", + { + "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" + }, + "> | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L135" + } + }, + { + "id": "def-public.IEmbeddable.render", + "type": "Function", + "label": "render", + "signature": [ + "(domNode: Element | HTMLElement) => void" + ], + "description": [ + "\nRenders the embeddable at the given node." + ], + "children": [ + { + "type": "CompoundType", + "label": "domNode", + "isRequired": true, + "signature": [ + "Element | HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L141" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L141" + } + }, + { + "id": "def-public.IEmbeddable.reload", + "type": "Function", + "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": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L147" + } + }, + { + "id": "def-public.IEmbeddable.getInspectorAdapters", + "type": "Function", + "label": "getInspectorAdapters", + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | 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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L154" + } + }, + { + "id": "def-public.IEmbeddable.destroy", + "type": "Function", + "label": "destroy", + "signature": [ + "() => void" + ], + "description": [ + "\nCleans up subscriptions, destroy nodes mounted from calls to render." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L159" + } + }, + { + "id": "def-public.IEmbeddable.supportedTriggers", + "type": "Function", + "label": "supportedTriggers", + "signature": [ + "() => string[]" + ], + "description": [ + "\nList of triggers that this embeddable will execute." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L164" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.OutputSpec", + "type": "Interface", + "label": "OutputSpec", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.OutputSpec.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L24" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PanelState", + "type": "Interface", + "label": "PanelState", + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PanelState.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L57" + } + }, + { + "tags": [], + "id": "def-public.PanelState.explicitInput", + "type": "CompoundType", + "label": "explicitInput", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L62" + }, + "signature": [ + "Partial & { id: string; }" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PropertySpec", + "type": "Interface", + "label": "PropertySpec", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PropertySpec.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.PropertySpec.accessPath", + "type": "string", + "label": "accessPath", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.PropertySpec.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.PropertySpec.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.PropertySpec.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L22" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectEmbeddableInput", + "type": "Interface", + "label": "SavedObjectEmbeddableInput", + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectEmbeddableInput.savedObjectId", + "type": "string", + "label": "savedObjectId", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L12" + } + } + ], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableEditorState", + "type": "Interface", + "label": "EmbeddableEditorState", + "description": [ + "\nA state package that contains information an editor will need to create or edit an embeddable then redirect back." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableEditorState.originatingApp", + "type": "string", + "label": "originatingApp", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.EmbeddableEditorState.embeddableId", + "type": "string", + "label": "embeddableId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableEditorState.valueInput", + "type": "Object", + "label": "valueInput", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L21" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddablePackageState", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddablePackageState.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L35" + } + }, + { + "tags": [], + "id": "def-public.EmbeddablePackageState.input", + "type": "CompoundType", + "label": "input", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L36" + }, + "signature": [ + "Optional", + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", \"id\"> | ", + "Optional", + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + }, + ", \"id\">" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddablePackageState.embeddableId", + "type": "string", + "label": "embeddableId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L37" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EnhancementRegistryDefinition", + "type": "Interface", + "label": "EnhancementRegistryDefinition", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "

extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + "

>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EnhancementRegistryDefinition.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/types.ts#L28" + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableSetupDependencies", + "type": "Interface", + "label": "EmbeddableSetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableSetupDependencies.uiActions", + "type": "Object", + "label": "uiActions", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L54" + }, + "signature": [ + "Pick<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableStartDependencies", + "type": "Interface", + "label": "EmbeddableStartDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableStartDependencies.uiActions", + "type": "Object", + "label": "uiActions", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L58" + }, + "signature": [ + "Pick<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ", ", + "MethodKeysOf", + "<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + ">>" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStartDependencies.inspector", + "type": "Object", + "label": "inspector", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L59" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Start", + "text": "Start" + } + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L57" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.ViewMode", + "type": "Enum", + "label": "ViewMode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L11" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-public.ACTION_ADD_PANEL", + "type": "string", + "label": "ACTION_ADD_PANEL", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L17" + }, + "signature": [ + "\"ACTION_ADD_PANEL\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ACTION_EDIT_PANEL", + "type": "string", + "label": "ACTION_EDIT_PANEL", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L25" + }, + "signature": [ + "\"editPanel\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ChartActionContext", + "type": "Type", + "label": "ChartActionContext", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L42" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" + }, + " | ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.RowClickContext", + "text": "RowClickContext" + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.CONTEXT_MENU_TRIGGER", + "type": "string", + "label": "CONTEXT_MENU_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L47" + }, + "signature": [ + "\"CONTEXT_MENU_TRIGGER\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableFactoryDefinition", + "type": "Type", + "label": "EmbeddableFactoryDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts#L14" + }, + "signature": [ + "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableInput", + "type": "Type", + "label": "EmbeddableInput", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L16" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.PANEL_BADGE_TRIGGER", + "type": "string", + "label": "PANEL_BADGE_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L58" + }, + "signature": [ + "\"PANEL_BADGE_TRIGGER\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.PANEL_NOTIFICATION_TRIGGER", + "type": "string", + "label": "PANEL_NOTIFICATION_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L69" + }, + "signature": [ + "\"PANEL_NOTIFICATION_TRIGGER\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.SELECT_RANGE_TRIGGER", + "type": "string", + "label": "SELECT_RANGE_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L80" + }, + "signature": [ + "\"SELECT_RANGE_TRIGGER\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.VALUE_CLICK_TRIGGER", + "type": "string", + "label": "VALUE_CLICK_TRIGGER", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L91" + }, + "signature": [ + "\"VALUE_CLICK_TRIGGER\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableRendererProps", + "type": "Type", + "label": "EmbeddableRendererProps", + "tags": [], + "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" + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L21" + }, + "signature": [ + "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ATTRIBUTE_SERVICE_KEY", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L30" + }, + "signature": [ + "\"attributes\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddablePanelHOC", + "type": "Type", + "label": "EmbeddablePanelHOC", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L98" + }, + "signature": [ + "(props: React.PropsWithChildren<{ embeddable: ", + { + "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" + }, + ">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.contextMenuTrigger", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.contextMenuTrigger.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L49" + } + }, + { + "tags": [], + "id": "def-public.contextMenuTrigger.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L50" + } + }, + { + "tags": [], + "id": "def-public.contextMenuTrigger.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L53" + } + } + ], + "description": [], + "label": "contextMenuTrigger", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-public.panelBadgeTrigger", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.panelBadgeTrigger.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L60" + } + }, + { + "tags": [], + "id": "def-public.panelBadgeTrigger.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L61" + } + }, + { + "tags": [], + "id": "def-public.panelBadgeTrigger.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L64" + } + } + ], + "description": [], + "label": "panelBadgeTrigger", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L59" + }, + "initialIsOpen": false + }, + { + "id": "def-public.panelNotificationTrigger", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.panelNotificationTrigger.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L71" + } + }, + { + "tags": [], + "id": "def-public.panelNotificationTrigger.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L72" + } + }, + { + "tags": [], + "id": "def-public.panelNotificationTrigger.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L75" + } + } + ], + "description": [], + "label": "panelNotificationTrigger", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L70" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-public.EmbeddableSetup", + "type": "Interface", + "label": "EmbeddableSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableSetup.registerEmbeddableFactory", + "type": "Function", + "label": "registerEmbeddableFactory", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L63" + }, + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(id: string, factory: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + } + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableSetup.registerEnhancement", + "type": "Function", + "label": "registerEnhancement", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L71" + }, + "signature": [ + "(enhancement: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">) => void" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider", + "type": "Function", + "label": "setCustomEmbeddableFactoryProvider", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L72" + }, + "signature": [ + "(customProvider: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryProvider", + "text": "EmbeddableFactoryProvider" + }, + ") => void" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L62" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.EmbeddableStart", + "type": "Interface", + "label": "EmbeddableStart", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStart", + "text": "EmbeddableStart" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableStart.getEmbeddableFactory", + "type": "Function", + "label": "getEmbeddableFactory", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L76" + }, + "signature": [ + " IterableIterator<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStart.EmbeddablePanel", + "type": "Function", + "label": "EmbeddablePanel", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L84" + }, + "signature": [ + "React.FC<{ embeddable: ", + { + "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" + }, + ">; hideHeader?: boolean | undefined; }>" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStart.getStateTransfer", + "type": "Function", + "label": "getStateTransfer", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L85" + }, + "signature": [ + "(storage?: ", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.Storage", + "text": "Storage" + }, + " | undefined) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStateTransfer", + "text": "EmbeddableStateTransfer" + } + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableStart.getAttributeService", + "type": "Function", + "label": "getAttributeService", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L86" + }, + "signature": [ + "(type: string, options: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.AttributeServiceOptions", + "text": "AttributeServiceOptions" + } + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L75" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.EnhancementRegistryDefinition", + "type": "Interface", + "label": "EnhancementRegistryDefinition", + "signature": [ + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "

extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + "

>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EnhancementRegistryDefinition.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.EmbeddableRegistryDefinition", + "type": "Interface", + "label": "EmbeddableRegistryDefinition", + "signature": [ + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EmbeddableRegistryDefinition", + "text": "EmbeddableRegistryDefinition" + }, + "

extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + "

>" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EmbeddableRegistryDefinition.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L32" + } + } + ], + "source": { + "path": "src/plugins/embeddable/server/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L29" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.EmbeddableSetup", + "type": "Interface", + "label": "EmbeddableSetup", + "signature": [ + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EmbeddableSetup", + "text": "EmbeddableSetup" + }, + " extends ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EmbeddableSetup.registerEmbeddableFactory", + "type": "Function", + "label": "registerEmbeddableFactory", + "description": [], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L28" + }, + "signature": [ + "(factory: ", + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EmbeddableRegistryDefinition", + "text": "EmbeddableRegistryDefinition" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + ">) => void" + ] + }, + { + "tags": [], + "id": "def-server.EmbeddableSetup.registerEnhancement", + "type": "Function", + "label": "registerEnhancement", + "description": [], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L29" + }, + "signature": [ + "(enhancement: ", + { + "pluginId": "embeddable", + "scope": "server", + "docId": "kibEmbeddablePluginApi", + "section": "def-server.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">) => void" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/server/plugin.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L27" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.getExtractFunction", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "embeddables", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/extract.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/extract.ts#L13" + } + } + ], + "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" + }, + ") => { state: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + }, + "; references: ", + "SavedObjectReference", + "[]; }" + ], + "description": [], + "label": "getExtractFunction", + "source": { + "path": "src/plugins/embeddable/common/lib/extract.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/extract.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getInjectFunction", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "embeddables", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/inject.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/inject.ts#L14" + } + } + ], + "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" + }, + ", references: ", + "SavedObjectReference", + "[]) => ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" + } + ], + "description": [], + "label": "getInjectFunction", + "source": { + "path": "src/plugins/embeddable/common/lib/inject.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/inject.ts#L14" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getMigrateFunction", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "embeddables", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate.ts#L13" + } + } + ], + "signature": [ + "(embeddables: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + }, + ") => (state: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ", version: string) => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "label": "getMigrateFunction", + "source": { + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.telemetryBaseEmbeddableInput", + "type": "Function", + "children": [ + { + "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": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L14" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L15" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.extractBaseEmbeddableInput", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L20" + } + } + ], + "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", + "[]; }" + ], + "description": [], + "label": "extractBaseEmbeddableInput", + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L20" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.injectBaseEmbeddableInput", + "type": "Function", + "children": [ + { + "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": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L25" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L26" + } + } + ], + "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" + } + ], + "description": [], + "label": "injectBaseEmbeddableInput", + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getTelemetryFunction", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "embeddables", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/telemetry.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/telemetry.ts#L12" + } + } + ], + "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" + ], + "description": [], + "label": "getTelemetryFunction", + "source": { + "path": "src/plugins/embeddable/common/lib/telemetry.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/telemetry.ts#L12" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isSavedObjectEmbeddableInput", + "type": "Function", + "label": "isSavedObjectEmbeddableInput", + "signature": [ + "(input: ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + }, + ") => boolean" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L15" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.PanelState", + "type": "Interface", + "label": "PanelState", + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PanelState.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.PanelState.explicitInput", + "type": "CompoundType", + "label": "explicitInput", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L62" + }, + "signature": [ + "Partial & { id: string; }" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CommonEmbeddableStartContract", + "type": "Interface", + "label": "CommonEmbeddableStartContract", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", + "type": "Function", + "label": "getEmbeddableFactory", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L70" + }, + "signature": [ + "(embeddableFactoryId: string) => any" + ] + }, + { + "tags": [], + "id": "def-common.CommonEmbeddableStartContract.getEnhancement", + "type": "Function", + "label": "getEnhancement", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L71" + }, + "signature": [ + "(enhancementId: string) => any" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectEmbeddableInput", + "type": "Interface", + "label": "SavedObjectEmbeddableInput", + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObjectEmbeddableInput.savedObjectId", + "type": "string", + "label": "savedObjectId", + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L12" + } + } + ], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L11" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.ViewMode", + "type": "Enum", + "label": "ViewMode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L11" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-common.EmbeddableInput", + "type": "Type", + "label": "EmbeddableInput", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L16" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EmbeddableStateWithType", + "type": "Type", + "label": "EmbeddableStateWithType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L65" + }, + "signature": [ + "EmbeddableInput & { type: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EmbeddablePersistableStateService", + "type": "Type", + "label": "EmbeddablePersistableStateService", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L67" + }, + "signature": [ + "PersistableStateService" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-common.baseEmbeddableMigrations", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "baseEmbeddableMigrations", + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L31" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx new file mode 100644 index 0000000000000..9882116372b04 --- /dev/null +++ b/api_docs/embeddable.mdx @@ -0,0 +1,64 @@ +--- +id: kibEmbeddablePluginApi +slug: /kibana-dev-docs/embeddablePluginApi +title: embeddable +image: https://source.unsplash.com/400x175/?github +summary: API docs for the embeddable plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import embeddableObj from './embeddable.json'; + +## Client + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Interfaces + + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json new file mode 100644 index 0000000000000..63b9eed7c3c41 --- /dev/null +++ b/api_docs/embeddable_enhanced.json @@ -0,0 +1,363 @@ +{ + "id": "embeddableEnhanced", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.isEnhancedEmbeddable", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "maybeEnhancedEmbeddable", + "isRequired": true, + "signature": [ + "E" + ], + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L12" + } + } + ], + "signature": [ + "(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ", + { + "pluginId": "embeddableEnhanced", + "scope": "public", + "docId": "kibEmbeddableEnhancedPluginApi", + "section": "def-public.EnhancedEmbeddable", + "text": "EnhancedEmbeddable" + }, + " ? E : never>" + ], + "description": [], + "label": "isEnhancedEmbeddable", + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.SetupDependencies", + "type": "Interface", + "label": "SetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SetupDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L36" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableSetup", + "text": "EmbeddableSetup" + } + ] + }, + { + "tags": [], + "id": "def-public.SetupDependencies.uiActionsEnhanced", + "type": "Object", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L37" + }, + "signature": [ + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.SetupContract", + "text": "SetupContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.StartDependencies", + "type": "Interface", + "label": "StartDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.StartDependencies.embeddable", + "type": "Object", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L41" + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStart", + "text": "EmbeddableStart" + } + ] + }, + { + "tags": [], + "id": "def-public.StartDependencies.uiActionsEnhanced", + "type": "Object", + "label": "uiActionsEnhanced", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L42" + }, + "signature": [ + { + "pluginId": "uiActionsEnhanced", + "scope": "public", + "docId": "kibUiActionsEnhancedPluginApi", + "section": "def-public.StartContract", + "text": "StartContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-public.EnhancedEmbeddableContext", + "type": "Interface", + "label": "EnhancedEmbeddableContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EnhancedEmbeddableContext.embeddable", + "type": "CompoundType", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L21" + }, + "signature": [ + { + "pluginId": "embeddableEnhanced", + "scope": "public", + "docId": "kibEmbeddableEnhancedPluginApi", + "section": "def-public.EnhancedEmbeddable", + "text": "EnhancedEmbeddable" + }, + "<", + { + "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": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L20" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.EnhancedEmbeddable", + "type": "Type", + "label": "EnhancedEmbeddable", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L11" + }, + "signature": [ + "E & { enhancements: { dynamicActions: DynamicActionManager;}; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.drilldownGrouping", + "type": "Array", + "label": "drilldownGrouping", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts#L12" + }, + "signature": [ + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.PresentableGrouping", + "text": "PresentableGrouping" + }, + "<{ embeddable?: ", + { + "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" + }, + "> | undefined; }>" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.SetupContract", + "type": "Interface", + "label": "SetupContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L46" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.StartContract", + "type": "Interface", + "label": "StartContract", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L49" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx new file mode 100644 index 0000000000000..58800f0e7d343 --- /dev/null +++ b/api_docs/embeddable_enhanced.mdx @@ -0,0 +1,30 @@ +--- +id: kibEmbeddableEnhancedPluginApi +slug: /kibana-dev-docs/embeddableEnhancedPluginApi +title: embeddableEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the embeddableEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import embeddableEnhancedObj from './embeddable_enhanced.json'; + +## Client + +### Setup + + +### Start + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json new file mode 100644 index 0000000000000..c4583698f6ff0 --- /dev/null +++ b/api_docs/encrypted_saved_objects.json @@ -0,0 +1,390 @@ +{ + "id": "encryptedSavedObjects", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "id": "def-server.EncryptionError", + "type": "Class", + "tags": [], + "label": "EncryptionError", + "description": [], + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptionError", + "text": "EncryptionError" + }, + " extends Error" + ], + "children": [ + { + "id": "def-server.EncryptionError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L18" + } + }, + { + "type": "string", + "label": "attributeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L19" + } + }, + { + "type": "Enum", + "label": "operation", + "isRequired": true, + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptionErrorOperation", + "text": "EncryptionErrorOperation" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L20" + } + }, + { + "type": "Object", + "label": "cause", + "isRequired": false, + "signature": [ + "Error | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L17" + } + }, + { + "id": "def-server.EncryptionError.toJSON", + "type": "Function", + "label": "toJSON", + "signature": [ + "() => { message: string; }" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L30" + } + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L16" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-server.EncryptedSavedObjectTypeRegistration", + "type": "Interface", + "label": "EncryptedSavedObjectTypeRegistration", + "description": [ + "\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EncryptedSavedObjectTypeRegistration.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L34" + } + }, + { + "tags": [], + "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt", + "type": "Object", + "label": "attributesToEncrypt", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L35" + }, + "signature": [ + "ReadonlySet" + ] + }, + { + "tags": [], + "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD", + "type": "Object", + "label": "attributesToExcludeFromAAD", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L36" + }, + "signature": [ + "ReadonlySet | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-server.EncryptedSavedObjectsClient", + "type": "Interface", + "label": "EncryptedSavedObjectsClient", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser", + "type": "Function", + "label": "getDecryptedAsInternalUser", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L41" + }, + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L40" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-server.EncryptedSavedObjectsPluginSetup", + "type": "Interface", + "label": "EncryptedSavedObjectsPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt", + "type": "boolean", + "label": "canEncrypt", + "description": [ + "\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`." + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L35" + } + }, + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType", + "type": "Function", + "label": "registerType", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L36" + }, + "signature": [ + "(typeRegistration: ", + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectTypeRegistration", + "text": "EncryptedSavedObjectTypeRegistration" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration", + "type": "Function", + "label": "createMigration", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L37" + }, + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.CreateEncryptedSavedObjectsMigrationFn", + "text": "CreateEncryptedSavedObjectsMigrationFn" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L31" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.EncryptedSavedObjectsPluginStart", + "type": "Interface", + "label": "EncryptedSavedObjectsPluginStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError", + "type": "Function", + "label": "isEncryptionError", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L41" + }, + "signature": [ + "(error: Error) => boolean" + ] + }, + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsPluginStart.getClient", + "type": "Function", + "label": "getClient", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L42" + }, + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.ClientInstanciator", + "text": "ClientInstanciator" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L40" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx new file mode 100644 index 0000000000000..654427d83c359 --- /dev/null +++ b/api_docs/encrypted_saved_objects.mdx @@ -0,0 +1,27 @@ +--- +id: kibEncryptedSavedObjectsPluginApi +slug: /kibana-dev-docs/encryptedSavedObjectsPluginApi +title: encryptedSavedObjects +image: https://source.unsplash.com/400x175/?github +summary: API docs for the encryptedSavedObjects plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import encryptedSavedObjectsObj from './encrypted_saved_objects.json'; + +## Server + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json new file mode 100644 index 0000000000000..dab40f56f6d69 --- /dev/null +++ b/api_docs/enterprise_search.json @@ -0,0 +1,69 @@ +{ + "id": "enterpriseSearch", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "id": "def-server.ConfigType", + "type": "Type", + "label": "ConfigType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L24" + }, + "signature": [ + "{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-server.configSchema", + "type": "Object", + "label": "configSchema", + "description": [], + "source": { + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L17" + }, + "signature": [ + "ObjectType", + "<{ host: ", + "Type", + "; enabled: ", + "Type", + "; accessCheckTimeout: ", + "Type", + "; accessCheckTimeoutWarning: ", + "Type" + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx new file mode 100644 index 0000000000000..1f9dfaae078f4 --- /dev/null +++ b/api_docs/enterprise_search.mdx @@ -0,0 +1,21 @@ +--- +id: kibEnterpriseSearchPluginApi +slug: /kibana-dev-docs/enterpriseSearchPluginApi +title: enterpriseSearch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the enterpriseSearch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import enterpriseSearchObj from './enterprise_search.json'; + +## Server + +### Objects + + +### Consts, variables and types + + diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json new file mode 100644 index 0000000000000..406f95613fa35 --- /dev/null +++ b/api_docs/es_ui_shared.json @@ -0,0 +1,1558 @@ +{ + "id": "esUiShared", + "client": { + "classes": [ + { + "id": "def-public.CronEditor", + "type": "Class", + "tags": [], + "label": "CronEditor", + "description": [], + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.CronEditor", + "text": "CronEditor" + }, + " extends React.Component" + ], + "children": [ + { + "id": "def-public.CronEditor.getDerivedStateFromProps", + "type": "Function", + "label": "getDerivedStateFromProps", + "signature": [ + "typeof ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.CronEditor", + "text": "CronEditor" + }, + ".getDerivedStateFromProps" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65" + } + }, + { + "id": "def-public.CronEditor.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70" + } + }, + { + "id": "def-public.CronEditor.onChangeFrequency", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "frequency", + "isRequired": true, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.Frequency", + "text": "Frequency" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80" + } + } + ], + "signature": [ + "(frequency: ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.Frequency", + "text": "Frequency" + }, + ") => void" + ], + "description": [], + "label": "onChangeFrequency", + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.CronEditor.onChangeFields", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "fields", + "isRequired": true, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.FieldToValueMap", + "text": "FieldToValueMap" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104" + } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.FieldToValueMap", + "text": "FieldToValueMap" + }, + ") => void" + ], + "description": [], + "label": "onChangeFields", + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.CronEditor.renderForm", + "type": "Function", + "label": "renderForm", + "signature": [ + "() => JSX.Element | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L140" + } + }, + { + "id": "def-public.CronEditor.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L215" + } + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L64" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "tags": [], + "id": "def-public.JsonEditor", + "type": "Function", + "label": "JsonEditor", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx#L102" + }, + "signature": [ + "typeof JsonEditorComp" + ], + "initialIsOpen": false + }, + { + "id": "def-public.SectionLoading", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{ inline, children, ...rest }", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.sendRequest", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "httpClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L29" + } + }, + { + "type": "Object", + "label": "{ path, method, body, query, asSystemRequest }", + "isRequired": true, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.SendRequestConfig", + "text": "SendRequestConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L30" + } + } + ], + "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" + }, + ">" + ], + "description": [], + "label": "sendRequest", + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.useRequest", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "httpClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L29" + } + }, + { + "type": "Object", + "label": "{ path, method, query, body, pollIntervalMs, initialData, deserializer }", + "isRequired": true, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.UseRequestConfig", + "text": "UseRequestConfig" + } + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L30" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.AuthorizationProvider", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ privilegesEndpoint, httpClient, children }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.NotAuthorizedSection", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ title, message }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.WithPrivileges", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ privileges: requiredPrivileges, children }", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.SectionError", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n title,\n error,\n actions,\n ...rest\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L35" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.extractQueryParams", + "type": "Function", + "label": "extractQueryParams", + "signature": [ + "(queryString: string) => ", + "ParsedQuery", + "" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "queryString", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.attemptToURIDecode", + "type": "Function", + "children": [ + { + "type": "string", + "label": "value", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.JsonEditorState", + "type": "Interface", + "label": "JsonEditorState", + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.JsonEditorState", + "text": "JsonEditorState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.JsonEditorState.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L15" + }, + "signature": [ + "{ raw: string; format(): T; }" + ] + }, + { + "id": "def-public.JsonEditorState.validate", + "type": "Function", + "label": "validate", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.JsonEditorState.isValid", + "type": "CompoundType", + "label": "isValid", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SendRequestConfig", + "type": "Interface", + "label": "SendRequestConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SendRequestConfig.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.SendRequestConfig.method", + "type": "CompoundType", + "label": "method", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L13" + }, + "signature": [ + "\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" + ] + }, + { + "tags": [], + "id": "def-public.SendRequestConfig.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L14" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SendRequestConfig.body", + "type": "Any", + "label": "body", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L15" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.SendRequestConfig.asSystemRequest", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SendRequestResponse", + "type": "Interface", + "label": "SendRequestResponse", + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.SendRequestResponse", + "text": "SendRequestResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SendRequestResponse.data", + "type": "CompoundType", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L24" + }, + "signature": [ + "D | null" + ] + }, + { + "tags": [], + "id": "def-public.SendRequestResponse.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L25" + }, + "signature": [ + "E | null" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/send_request.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UseRequestConfig", + "type": "Interface", + "label": "UseRequestConfig", + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.UseRequestConfig", + "text": "UseRequestConfig" + }, + " extends ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.SendRequestConfig", + "text": "SendRequestConfig" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.UseRequestConfig.pollIntervalMs", + "type": "number", + "label": "pollIntervalMs", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L15" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UseRequestConfig.initialData", + "type": "Any", + "label": "initialData", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L16" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.UseRequestConfig.deserializer", + "type": "Function", + "label": "deserializer", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L17" + }, + "signature": [ + "((data: any) => any) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UseRequestResponse", + "type": "Interface", + "label": "UseRequestResponse", + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.UseRequestResponse", + "text": "UseRequestResponse" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.UseRequestResponse.isInitialRequest", + "type": "boolean", + "label": "isInitialRequest", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.UseRequestResponse.isLoading", + "type": "boolean", + "label": "isLoading", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L22" + } + }, + { + "tags": [], + "id": "def-public.UseRequestResponse.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L23" + }, + "signature": [ + "E | null" + ] + }, + { + "tags": [], + "id": "def-public.UseRequestResponse.data", + "type": "CompoundType", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L24" + }, + "signature": [ + "D | null | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UseRequestResponse.resendRequest", + "type": "Function", + "label": "resendRequest", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L25" + }, + "signature": [ + "() => void" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Privileges", + "type": "Interface", + "label": "Privileges", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Privileges.hasAllPrivileges", + "type": "boolean", + "label": "hasAllPrivileges", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.Privileges.missingPrivileges", + "type": "Object", + "label": "missingPrivileges", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15" + }, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "common", + "docId": "kibEsUiSharedPluginApi", + "section": "def-common.MissingPrivileges", + "text": "MissingPrivileges" + } + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.MissingPrivileges", + "type": "Interface", + "label": "MissingPrivileges", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.MissingPrivileges.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Error", + "type": "Interface", + "label": "Error", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Error.error", + "type": "string", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L13" + } + }, + { + "tags": [], + "id": "def-public.Error.cause", + "type": "Array", + "label": "cause", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L14" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Error.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L15" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L12" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.OnJsonEditorUpdateHandler", + "type": "Type", + "label": "OnJsonEditorUpdateHandler", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L23" + }, + "signature": [ + "(arg: ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.JsonEditorState", + "text": "JsonEditorState" + }, + ") => void" + ], + "initialIsOpen": false + }, + { + "id": "def-public.Frequency", + "type": "Type", + "label": "Frequency", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/types.ts#L9" + }, + "signature": [ + "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.indices", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.indices.INDEX_ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "label": "INDEX_ILLEGAL_CHARACTERS_VISIBLE", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L18" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.indices.indexNameBeginsWithPeriod", + "type": "Function", + "label": "indexNameBeginsWithPeriod", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L19" + }, + "signature": [ + "typeof ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.indexNameBeginsWithPeriod", + "text": "indexNameBeginsWithPeriod" + } + ] + }, + { + "tags": [], + "id": "def-public.indices.findIllegalCharactersInIndexName", + "type": "Function", + "label": "findIllegalCharactersInIndexName", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L20" + }, + "signature": [ + "typeof ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.findIllegalCharactersInIndexName", + "text": "findIllegalCharactersInIndexName" + } + ] + }, + { + "tags": [], + "id": "def-public.indices.indexNameContainsSpaces", + "type": "Function", + "label": "indexNameContainsSpaces", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L21" + }, + "signature": [ + "typeof ", + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.indexNameContainsSpaces", + "text": "indexNameContainsSpaces" + } + ] + } + ], + "description": [], + "label": "indices", + "source": { + "path": "src/plugins/es_ui_shared/public/indices/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L17" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.AuthorizationContext", + "type": "Object", + "label": "AuthorizationContext", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L33" + }, + "signature": [ + "React.Context" + ], + "initialIsOpen": false + } + ] + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.isEsError", + "type": "Function", + "label": "isEsError", + "signature": [ + "(err: RequestError) => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "err", + "isRequired": true, + "signature": [ + "RequestError" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-server.handleEsError", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n error,\n response,\n handleCustomError,\n}", + "isRequired": true, + "signature": [ + "EsErrorHandlerParams" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" + } + } + ], + "signature": [ + "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "description": [], + "label": "handleEsError", + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-server.parseEsError", + "type": "Function", + "children": [ + { + "type": "string", + "label": "err", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-common.Privileges", + "type": "Interface", + "label": "Privileges", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Privileges.hasAllPrivileges", + "type": "boolean", + "label": "hasAllPrivileges", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.Privileges.missingPrivileges", + "type": "Object", + "label": "missingPrivileges", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15" + }, + "signature": [ + { + "pluginId": "esUiShared", + "scope": "common", + "docId": "kibEsUiSharedPluginApi", + "section": "def-common.MissingPrivileges", + "text": "MissingPrivileges" + } + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MissingPrivileges", + "type": "Interface", + "label": "MissingPrivileges", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.MissingPrivileges.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx new file mode 100644 index 0000000000000..2fd04e135e3fd --- /dev/null +++ b/api_docs/es_ui_shared.mdx @@ -0,0 +1,40 @@ +--- +id: kibEsUiSharedPluginApi +slug: /kibana-dev-docs/esUiSharedPluginApi +title: esUiShared +image: https://source.unsplash.com/400x175/?github +summary: API docs for the esUiShared plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import esUiSharedObj from './es_ui_shared.json'; + +## Client + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Functions + + +## Common + +### Interfaces + + diff --git a/api_docs/event_log.json b/api_docs/event_log.json new file mode 100644 index 0000000000000..08bd555f1ea80 --- /dev/null +++ b/api_docs/event_log.json @@ -0,0 +1,715 @@ +{ + "id": "eventLog", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.IEventLogger", + "type": "Interface", + "label": "IEventLogger", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.IEventLogger.logEvent", + "type": "Function", + "label": "logEvent", + "signature": [ + "(properties: DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "properties", + "isRequired": false, + "signature": [ + "DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53" + } + }, + { + "id": "def-server.IEventLogger.startTiming", + "type": "Function", + "label": "startTiming", + "signature": [ + "(event: DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "event", + "isRequired": false, + "signature": [ + "DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54" + } + }, + { + "id": "def-server.IEventLogger.stopTiming", + "type": "Function", + "label": "stopTiming", + "signature": [ + "(event: DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "event", + "isRequired": false, + "signature": [ + "DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55" + } + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IEventLogClient", + "type": "Interface", + "label": "IEventLogClient", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.IEventLogClient.findEventsBySavedObjectIds", + "type": "Function", + "label": "findEventsBySavedObjectIds", + "signature": [ + "(type: string, ids: string[], options?: Partial<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.FindOptionsType", + "text": "FindOptionsType" + }, + "> | undefined) => Promise<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.QueryEventsBySavedObjectResult", + "text": "QueryEventsBySavedObjectResult" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L46" + } + }, + { + "type": "Array", + "label": "ids", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L47" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + "Partial<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.FindOptionsType", + "text": "FindOptionsType" + }, + "> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L45" + } + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.QueryEventsBySavedObjectResult", + "type": "Interface", + "label": "QueryEventsBySavedObjectResult", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.QueryEventsBySavedObjectResult.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L35" + } + }, + { + "tags": [], + "id": "def-server.QueryEventsBySavedObjectResult.per_page", + "type": "number", + "label": "per_page", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L36" + } + }, + { + "tags": [], + "id": "def-server.QueryEventsBySavedObjectResult.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L37" + } + }, + { + "tags": [], + "id": "def-server.QueryEventsBySavedObjectResult.data", + "type": "Array", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L38" + }, + "signature": [ + "(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L34" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.IEvent", + "type": "Type", + "label": "IEvent", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/generated/schemas.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L26" + }, + "signature": [ + "undefined | DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IValidatedEvent", + "type": "Type", + "label": "IValidatedEvent", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/generated/schemas.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L25" + }, + "signature": [ + "undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.SAVED_OBJECT_REL_PRIMARY", + "type": "string", + "label": "SAVED_OBJECT_REL_PRIMARY", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L18" + }, + "signature": [ + "\"primary\"" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.IEventLogService", + "type": "Interface", + "label": "IEventLogService", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.IEventLogService.isEnabled", + "type": "Function", + "label": "isEnabled", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L30" + } + }, + { + "id": "def-server.IEventLogService.isLoggingEntries", + "type": "Function", + "label": "isLoggingEntries", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L31" + } + }, + { + "id": "def-server.IEventLogService.isIndexingEntries", + "type": "Function", + "label": "isIndexingEntries", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L32" + } + }, + { + "id": "def-server.IEventLogService.registerProviderActions", + "type": "Function", + "label": "registerProviderActions", + "signature": [ + "(provider: string, actions: string[]) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "provider", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33" + } + }, + { + "type": "Array", + "label": "actions", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33" + } + }, + { + "id": "def-server.IEventLogService.isProviderActionRegistered", + "type": "Function", + "label": "isProviderActionRegistered", + "signature": [ + "(provider: string, action: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "provider", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34" + } + }, + { + "type": "string", + "label": "action", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34" + } + }, + { + "id": "def-server.IEventLogService.getProviderActions", + "type": "Function", + "label": "getProviderActions", + "signature": [ + "() => Map>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L35" + } + }, + { + "id": "def-server.IEventLogService.registerSavedObjectProvider", + "type": "Function", + "label": "registerSavedObjectProvider", + "signature": [ + "(type: string, provider: ", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.SavedObjectProvider", + "text": "SavedObjectProvider" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36" + } + }, + { + "type": "Function", + "label": "provider", + "isRequired": true, + "signature": [ + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.SavedObjectProvider", + "text": "SavedObjectProvider" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36" + } + }, + { + "id": "def-server.IEventLogService.getLogger", + "type": "Function", + "label": "getLogger", + "signature": [ + "(properties: DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.IEventLogger", + "text": "IEventLogger" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "properties", + "isRequired": false, + "signature": [ + "DeepPartial | 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<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37" + } + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L29" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.IEventLogClientService", + "type": "Interface", + "label": "IEventLogClientService", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.IEventLogClientService.getClient", + "type": "Function", + "label": "getClient", + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.IEventLogClient", + "text": "IEventLogClient" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41" + } + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L40" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.BASE_EVENT_LOG_API_PATH", + "type": "string", + "label": "BASE_EVENT_LOG_API_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/event_log/common/index.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/common/index.ts#L8" + }, + "signature": [ + "\"/api/event_log\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx new file mode 100644 index 0000000000000..2c212e5099f00 --- /dev/null +++ b/api_docs/event_log.mdx @@ -0,0 +1,32 @@ +--- +id: kibEventLogPluginApi +slug: /kibana-dev-docs/eventLogPluginApi +title: eventLog +image: https://source.unsplash.com/400x175/?github +summary: API docs for the eventLog plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import eventLogObj from './event_log.json'; + +## Server + +### Setup + + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/expressions.json b/api_docs/expressions.json new file mode 100644 index 0000000000000..9d50f8609f921 --- /dev/null +++ b/api_docs/expressions.json @@ -0,0 +1,35643 @@ +{ + "id": "expressions", + "client": { + "classes": [ + { + "id": "def-public.ExpressionsPublicPlugin", + "type": "Class", + "tags": [], + "label": "ExpressionsPublicPlugin", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsPublicPlugin", + "text": "ExpressionsPublicPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + ", ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + }, + ", object, object>" + ], + "children": [ + { + "id": "def-public.ExpressionsPublicPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ") => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L86" + } + } + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRenderHandler", + "type": "Class", + "tags": [], + "label": "ExpressionRenderHandler", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionRenderHandler.render$", + "type": "Object", + "label": "render$", + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L38" + }, + "signature": [ + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderHandler.update$", + "type": "Object", + "label": "update$", + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L39" + }, + "signature": [ + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderHandler.events$", + "type": "Object", + "label": "events$", + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L40" + }, + "signature": [ + "Observable", + "<", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ">" + ] + }, + { + "id": "def-public.ExpressionRenderHandler.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "element", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L52" + } + }, + { + "type": "Object", + "label": "{\n onRenderError,\n renderMode,\n syncColors,\n hasCompatibleActions = async () => false,\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderHandlerParams", + "text": "ExpressionRenderHandlerParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L51" + } + }, + { + "id": "def-public.ExpressionRenderHandler.render", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102" + } + }, + { + "type": "Any", + "label": "uiState", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102" + } + } + ], + "signature": [ + "(value: any, uiState?: any) => Promise" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionRenderHandler.destroy", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "destroy", + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L134" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionRenderHandler.getElement", + "type": "Function", + "children": [], + "signature": [ + "() => HTMLElement" + ], + "description": [], + "label": "getElement", + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L143" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionRenderHandler.handleRenderError", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderError", + "text": "ExpressionRenderError" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L147" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L147" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Execution", + "type": "Class", + "tags": [], + "label": "Execution", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.Execution.state", + "type": "Object", + "label": "state", + "description": [ + "\nDynamic state of the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.Execution.input", + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88" + }, + "signature": [ + "Input" + ] + }, + { + "tags": [], + "id": "def-public.Execution.context", + "type": "Object", + "label": "context", + "description": [ + "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.Execution.contract", + "type": "Object", + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140" + } + }, + { + "id": "def-public.Execution.result", + "type": "Object", + "label": "result", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142" + }, + "signature": [ + "Promise>" + ] + }, + { + "id": "def-public.Execution.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "id": "def-public.Execution.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "execution", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionParams", + "text": "ExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + }, + { + "id": "def-public.Execution.cancel", + "type": "Function", + "label": "cancel", + "signature": [ + "() => void" + ], + "description": [ + "\nStop execution of expression." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192" + } + }, + { + "id": "def-public.Execution.start", + "type": "Function", + "label": "start", + "signature": [ + "(input?: Input) => void" + ], + "description": [ + "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + }, + { + "id": "def-public.Execution.invokeChain", + "type": "Function", + "label": "invokeChain", + "signature": [ + "(chainArr: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[], input: unknown) => Promise" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "chainArr", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "id": "def-public.Execution.invokeFunction", + "type": "Function", + "label": "invokeFunction", + "signature": [ + "(fn: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, args: Record) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fn", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 318, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 316, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316" + } + }, + { + "id": "def-public.Execution.cast", + "type": "Function", + "label": "cast", + "signature": [ + "(value: any, toTypeNames?: string[] | undefined) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "type": "Array", + "label": "toTypeNames", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "id": "def-public.Execution.resolveArgs", + "type": "Function", + "label": "resolveArgs", + "signature": [ + "(fnDef: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, argAsts: any) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fnDef", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Any", + "label": "argAsts", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "id": "def-public.Execution.interpret", + "type": "Function", + "label": "interpret", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + }, + ", input: T) => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionContract", + "type": "Class", + "tags": [], + "label": "ExecutionContract", + "description": [ + "\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ], + "children": [ + { + "id": "def-public.ExecutionContract.isPending", + "type": "boolean", + "label": "isPending", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L18" + } + }, + { + "id": "def-public.ExecutionContract.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "execution", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24" + } + }, + { + "id": "def-public.ExecutionContract.cancel", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "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", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L31" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.getData", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "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; }> | Output>" + ], + "description": [ + "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." + ], + "label": "getData", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L40" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.getExpression", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "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", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L60" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.getAst", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nGet AST used to execute the expression." + ], + "label": "getAst", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L67" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.inspect", + "type": "Function", + "children": [], + "signature": [ + "() => InspectorAdapters" + ], + "description": [ + "\nGet Inspector adapters provided to all functions of expression through\nexecution context." + ], + "label": "inspect", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L73" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Executor", + "type": "Class", + "tags": [], + "label": "Executor", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ">" + ], + "children": [ + { + "id": "def-public.Executor.createWithDefaults", + "type": "Function", + "label": "createWithDefaults", + "signature": [ + "typeof ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ".createWithDefaults" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82" + } + }, + { + "tags": [], + "id": "def-public.Executor.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" + }, + "" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.Executor.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + } + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.Executor.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + } + ] + }, + { + "id": "def-public.Executor.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + }, + { + "id": "def-public.Executor.registerFunction", + "type": "Function", + "label": "registerFunction", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109" + } + }, + { + "id": "def-public.Executor.getFunction", + "type": "Function", + "label": "getFunction", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + }, + { + "id": "def-public.Executor.getFunctions", + "type": "Function", + "label": "getFunctions", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122" + } + }, + { + "id": "def-public.Executor.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126" + } + }, + { + "id": "def-public.Executor.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + }, + { + "id": "def-public.Executor.getTypes", + "type": "Function", + "label": "getTypes", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139" + } + }, + { + "id": "def-public.Executor.extendContext", + "type": "Function", + "label": "extendContext", + "signature": [ + "(extraContext: Record) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "extraContext", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + }, + { + "id": "def-public.Executor.context", + "type": "Object", + "label": "context", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-public.Executor.run", + "type": "Function", + "label": "run", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => Promise" + ], + "description": [ + "\nExecute expression and return result.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression AST or a string representing expression." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Initial input to the first expression function." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159" + } + }, + { + "id": "def-public.Executor.createExecution", + "type": "Function", + "label": "createExecution", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169" + } + }, + { + "id": "def-public.Executor.inject", + "type": "Function", + "label": "inject", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "id": "def-public.Executor.extract", + "type": "Function", + "label": "extract", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + }, + { + "id": "def-public.Executor.telemetry", + "type": "Function", + "label": "telemetry", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData: Record) => Record" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "id": "def-public.Executor.migrate", + "type": "Function", + "label": "migrate", + "signature": [ + "(ast: ", + { + "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" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "id": "def-public.Executor.fork", + "type": "Function", + "label": "fork", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunction", + "type": "Class", + "tags": [], + "label": "ExpressionFunction", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionFunction.name", + "type": "string", + "label": "name", + "description": [ + "\nName of function" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.aliases", + "type": "Array", + "label": "aliases", + "description": [ + "\nAliases that can be used instead of `name`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.type", + "type": "string", + "label": "type", + "description": [ + "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.fn", + "type": "Function", + "label": "fn", + "description": [ + "\nFunction to run function (context, args)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39" + }, + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44" + } + }, + { + "id": "def-public.ExpressionFunction.args", + "type": "Object", + "tags": [], + "children": [], + "description": [ + "\nSpecification of expression function parameters." + ], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [ + "\nType of inputs that this function supports." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.disabled", + "type": "boolean", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.telemetry", + "type": "Function", + "label": "telemetry", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57" + }, + "signature": [ + "(state: Record, telemetryData: Record) => Record" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61" + }, + "signature": [ + "(state: Record) => { state: Record; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.inject", + "type": "Function", + "label": "inject", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64" + }, + "signature": [ + "(state: Record, references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => Record" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.migrations", + "type": "Object", + "label": "migrations", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68" + }, + "signature": [ + "{ [key: string]: (state: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ") => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + "; }" + ] + }, + { + "id": "def-public.ExpressionFunction.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + }, + { + "id": "def-public.ExpressionFunction.accepts", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + } + } + ], + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "label": "accepts", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunctionParameter", + "type": "Class", + "tags": [], + "label": "ExpressionFunctionParameter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.resolve", + "type": "boolean", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionParameter.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20" + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-public.ExpressionFunctionParameter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "arg", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "id": "def-public.ExpressionFunctionParameter.accepts", + "type": "Function", + "label": "accepts", + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRenderer", + "type": "Class", + "tags": [], + "label": "ExpressionRenderer", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionRenderer.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderer.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderer.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderer.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15" + }, + "signature": [ + "() => void | Error" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderer.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderer.render", + "type": "Function", + "label": "render", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + }, + { + "id": "def-public.ExpressionRenderer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRendererRegistry", + "type": "Class", + "tags": [], + "label": "ExpressionRendererRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + ">" + ], + "children": [ + { + "id": "def-public.ExpressionRendererRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + }, + { + "id": "def-public.ExpressionRendererRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + }, + { + "id": "def-public.ExpressionRendererRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29" + } + }, + { + "id": "def-public.ExpressionRendererRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionType", + "type": "Class", + "tags": [], + "label": "ExpressionType", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.ExpressionType.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.ExpressionType.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nType validation, useful for checking function output." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L23" + }, + "signature": [ + "(type: any) => void | Error" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionType.serialize", + "type": "Function", + "label": "serialize", + "description": [ + "\nOptional serialization (used when passing context around client/server)." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30" + }, + "signature": [ + "((value: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31" + }, + "signature": [ + "((serialized: any) => any) | undefined" + ] + }, + { + "id": "def-public.ExpressionType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + }, + { + "id": "def-public.ExpressionType.getToFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getToFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.getFromFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getFromFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.castsTo", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsTo", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.castsFrom", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsFrom", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.to", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "string", + "label": "toTypeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + } + ], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.from", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + } + ], + "signature": [ + "(value: any, types: Record) => any" + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FunctionsRegistry", + "type": "Class", + "tags": [], + "label": "FunctionsRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ">" + ], + "children": [ + { + "id": "def-public.FunctionsRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + }, + { + "id": "def-public.FunctionsRegistry.register", + "type": "Function", + "label": "register", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61" + } + }, + { + "id": "def-public.FunctionsRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + }, + { + "id": "def-public.FunctionsRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71" + } + }, + { + "id": "def-public.FunctionsRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TypesRegistry", + "type": "Class", + "tags": [], + "label": "TypesRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ">" + ], + "children": [ + { + "id": "def-public.TypesRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + }, + { + "id": "def-public.TypesRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39" + } + }, + { + "id": "def-public.TypesRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + }, + { + "id": "def-public.TypesRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49" + } + }, + { + "id": "def-public.TypesRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionsService", + "type": "Class", + "tags": [], + "label": "ExpressionsService", + "description": [ + "\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionsService.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L175" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsService.renderers", + "type": "Object", + "label": "renderers", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L176" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + } + ] + }, + { + "id": "def-public.ExpressionsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionServiceParams", + "text": "ExpressionServiceParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178" + } + }, + { + "id": "def-public.ExpressionsService.registerFunction", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L219" + } + } + ], + "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" + ], + "description": [ + "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." + ], + "label": "registerFunction", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L218" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.registerType", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L223" + } + } + ], + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "label": "registerType", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L222" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.registerRenderer", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L227" + } + } + ], + "signature": [ + "(definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void" + ], + "description": [], + "label": "registerRenderer", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L226" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.run", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + } + ], + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise" + ], + "description": [], + "label": "run", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getFunction", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ], + "description": [], + "label": "getFunction", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getFunctions", + "type": "Function", + "children": [], + "signature": [ + "() => Record" + ], + "description": [ + "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." + ], + "label": "getFunctions", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L240" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getRenderer", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ], + "description": [], + "label": "getRenderer", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getRenderers", + "type": "Function", + "children": [], + "signature": [ + "() => Record>" + ], + "description": [ + "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." + ], + "label": "getRenderers", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getType", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ], + "description": [], + "label": "getType", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.getTypes", + "type": "Function", + "children": [], + "signature": [ + "() => Record" + ], + "description": [ + "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." + ], + "label": "getTypes", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L260" + }, + "tags": [], + "returnComment": [] + }, + { + "tags": [], + "id": "def-public.ExpressionsService.execute", + "type": "Function", + "label": "execute", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L262" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ] + }, + { + "id": "def-public.ExpressionsService.fork", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ], + "description": [], + "label": "fork", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L268" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.telemetry", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L281" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L282" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData?: Record) => Record" + ], + "description": [ + "\nExtracts telemetry from expression AST" + ], + "label": "telemetry", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 280, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L280" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionsService.extract", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ], + "description": [ + "\nExtracts saved object references from expression AST" + ], + "label": "extract", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292" + }, + "tags": [], + "returnComment": [ + "new expression AST with references removed and array of references" + ] + }, + { + "id": "def-public.ExpressionsService.inject", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nInjects saved object references into expression AST" + ], + "label": "inject", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + }, + "tags": [], + "returnComment": [ + "new expression AST with references injected" + ] + }, + { + "id": "def-public.ExpressionsService.migrate", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + } + } + ], + "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" + } + ], + "description": [ + "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" + ], + "label": "migrate", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + }, + "tags": [], + "returnComment": [ + "new migrated expression AST" + ] + }, + { + "id": "def-public.ExpressionsService.setup", + "type": "Function", + "label": "setup", + "signature": [ + "() => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [ + "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 320, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L320" + } + }, + { + "id": "def-public.ExpressionsService.start", + "type": "Function", + "label": "start", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } + ], + "description": [ + "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 328, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L328" + } + }, + { + "id": "def-public.ExpressionsService.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 332, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L332" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L174" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TablesAdapter", + "type": "Class", + "tags": [], + "label": "TablesAdapter", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TablesAdapter", + "text": "TablesAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-public.TablesAdapter.logDatatable", + "type": "Function", + "label": "logDatatable", + "signature": [ + "(name: string, datatable: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + }, + { + "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/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + }, + { + "id": "def-public.TablesAdapter.tables", + "type": "Object", + "label": "tables", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L20" + }, + "signature": [ + "{ [key: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionsInspectorAdapter", + "type": "Class", + "tags": [], + "label": "ExpressionsInspectorAdapter", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsInspectorAdapter", + "text": "ExpressionsInspectorAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-public.ExpressionsInspectorAdapter.logAST", + "type": "Function", + "label": "logAST", + "signature": [ + "(ast: any) => void" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "ast", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14" + } + }, + { + "id": "def-public.ExpressionsInspectorAdapter.ast", + "type": "Any", + "label": "ast", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L19" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionsPublicPlugin", + "type": "Class", + "tags": [], + "label": "ExpressionsPublicPlugin", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsPublicPlugin", + "text": "ExpressionsPublicPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + ", ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + }, + ", object, object>" + ], + "children": [ + { + "id": "def-public.ExpressionsPublicPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ") => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70" + } + }, + { + "id": "def-public.ExpressionsPublicPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L86" + } + } + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L37" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.ReactExpressionRenderer", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{\n className,\n dataAttrs,\n padding,\n renderError,\n expression,\n onEvent,\n onData$,\n reload$,\n debounce,\n ...expressionLoaderOptions\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L57" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L57" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.buildExpression", + "type": "Function", + "label": "buildExpression", + "signature": [ + "(initialState: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "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" + ], + "children": [ + { + "type": "CompoundType", + "label": "initialState", + "isRequired": false, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined" + ], + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-public.buildExpressionFunction", + "type": "Function", + "label": "buildExpressionFunction", + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "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" + ], + "children": [ + { + "type": "Uncategorized", + "label": "fnName", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "description": [ + "String representing the name of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155" + } + }, + { + "type": "Object", + "label": "initialArgs", + "isRequired": true, + "signature": [ + "{ [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }" + ], + "description": [ + "Object containing the arguments to this function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152" + }, + "initialIsOpen": false + }, + { + "id": "def-public.format", + "type": "Function", + "label": "format", + "signature": [ + "(ast: T, type: T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\") => string" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "ast", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "type", + "isRequired": true, + "signature": [ + "T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\"" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.formatExpression", + "type": "Function", + "label": "formatExpression", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => string" + ], + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression pipeline AST." + ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.isExpressionAstBuilder", + "type": "Function", + "label": "isExpressionAstBuilder", + "signature": [ + "(val: any) => boolean" + ], + "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" + ], + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "Value you want to check." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + } + } + ], + "tags": [ + "example", + "return" + ], + "returnComment": [ + "boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.parse", + "type": "Function", + "label": "parse", + "signature": [ + "(expression: E, startRule: S) => S extends \"expression\" ? ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " : ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + } + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "expression", + "isRequired": true, + "signature": [ + "E" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "startRule", + "isRequired": true, + "signature": [ + "S" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.parseExpression", + "type": "Function", + "label": "parseExpression", + "signature": [ + "(expression: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], + "children": [ + { + "type": "string", + "label": "expression", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Expression pipeline string." + ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.ExpressionExecutor", + "type": "Interface", + "label": "ExpressionExecutor", + "description": [], + "tags": [ + "deprecated" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionExecutor.interpreter", + "type": "Object", + "label": "interpreter", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L25" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionInterpreter", + "text": "ExpressionInterpreter" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IExpressionLoaderParams", + "type": "Interface", + "label": "IExpressionLoaderParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.searchContext", + "type": "Object", + "label": "searchContext", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L36" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.context", + "type": "Any", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L37" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.variables", + "type": "Object", + "label": "variables", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L38" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.debug", + "type": "CompoundType", + "label": "debug", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L40" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.disableCaching", + "type": "CompoundType", + "label": "disableCaching", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L41" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.customFunctions", + "type": "Object", + "label": "customFunctions", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L42" + }, + "signature": [ + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.customRenderers", + "type": "Object", + "label": "customRenderers", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L43" + }, + "signature": [ + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.uiState", + "type": "Unknown", + "label": "uiState", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L44" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.inspectorAdapters", + "type": "Object", + "label": "inspectorAdapters", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L45" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.onRenderError", + "type": "Function", + "label": "onRenderError", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L46" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.RenderErrorHandlerFnType", + "text": "RenderErrorHandlerFnType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.searchSessionId", + "type": "string", + "label": "searchSessionId", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L47" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.renderMode", + "type": "CompoundType", + "label": "renderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L48" + }, + "signature": [ + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.syncColors", + "type": "CompoundType", + "label": "syncColors", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L49" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L50" + }, + "signature": [ + "((event: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ") => Promise) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRenderError", + "type": "Interface", + "label": "ExpressionRenderError", + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderError", + "text": "ExpressionRenderError" + }, + " extends Error" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionRenderError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderError.original", + "type": "Object", + "label": "original", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L55" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ReactExpressionRendererProps", + "type": "Interface", + "label": "ReactExpressionRendererProps", + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.IExpressionLoaderParams", + "text": "IExpressionLoaderParams" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L24" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.dataAttrs", + "type": "Array", + "label": "dataAttrs", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L25" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.expression", + "type": "CompoundType", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L26" + }, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.renderError", + "type": "Function", + "label": "renderError", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L27" + }, + "signature": [ + "((message?: string | null | undefined, error?: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderError", + "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" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.padding", + "type": "CompoundType", + "label": "padding", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L31" + }, + "signature": [ + "\"m\" | \"s\" | \"l\" | \"xs\" | \"xl\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.onEvent", + "type": "Function", + "label": "onEvent", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L32" + }, + "signature": [ + "((event: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.onData$", + "type": "Function", + "label": "onData$", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L33" + }, + "signature": [ + "((data: TData, adapters?: TInspectorAdapters | undefined) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.reload$", + "type": "Object", + "label": "reload$", + "description": [ + "\nAn observable which can be used to re-run the expression without destroying the component" + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L37" + }, + "signature": [ + "Observable", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.debounce", + "type": "number", + "label": "debounce", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L38" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRendererEvent", + "type": "Interface", + "label": "ExpressionRendererEvent", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionRendererEvent.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRendererEvent.data", + "type": "Any", + "label": "data", + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L29" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Datatable", + "type": "Interface", + "label": "Datatable", + "description": [ + "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Datatable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-public.Datatable.columns", + "type": "Array", + "label": "columns", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.Datatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101" + }, + "signature": [ + "Record[]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98" + }, + "initialIsOpen": false + }, + { + "id": "def-public.DatatableColumn", + "type": "Interface", + "label": "DatatableColumn", + "description": [ + "\nThis type represents the shape of a column in a `Datatable`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DatatableColumn.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90" + } + }, + { + "tags": [], + "id": "def-public.DatatableColumn.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91" + } + }, + { + "tags": [], + "id": "def-public.DatatableColumn.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnMeta", + "text": "DatatableColumnMeta" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionContext", + "type": "Interface", + "label": "ExecutionContext", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ], + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExecutionContext.getSearchContext", + "type": "Function", + "label": "getSearchContext", + "description": [ + "\nGet search context of the expression." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28" + }, + "signature": [ + "() => ExecutionContextSearch" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.variables", + "type": "Object", + "label": "variables", + "description": [ + "\nContext variables that can be consumed using `var` and `var_set` functions." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.types", + "type": "Object", + "label": "types", + "description": [ + "\nA map of available expression types." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAdds ability to abort current execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43" + }, + "signature": [ + "AbortSignal" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "description": [ + "\nAdapters for `inspector` plugin." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.getSearchSessionId", + "type": "Function", + "label": "getSearchSessionId", + "description": [ + "\nSearch context in which expression should operate." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53" + }, + "signature": [ + "() => string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.getKibanaRequest", + "type": "Function", + "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": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60" + }, + "signature": [ + "(() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.getSavedObject", + "type": "Function", + "label": "getSavedObject", + "description": [ + "\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71" + }, + "signature": [ + "((type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionContext.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync colors across panels switch." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79" + }, + "signature": [ + "(() => boolean) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionParams", + "type": "Interface", + "label": "ExecutionParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExecutionParams.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionParams.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionParams.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionParams.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionState", + "type": "Interface", + "label": "ExecutionState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExecutionState.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [], + "id": "def-public.ExecutionState.state", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28" + }, + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionState.result", + "type": "Uncategorized", + "label": "result", + "description": [ + "\nResult of the expression execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33" + }, + "signature": [ + "Output | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExecutionState.error", + "type": "Object", + "label": "error", + "description": [ + "\nError happened during the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExecutorState", + "type": "Interface", + "label": "ExecutorState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExecutorState.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.ExecutorState.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-public.ExecutorState.context", + "type": "Uncategorized", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19" + }, + "signature": [ + "Context" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstExpressionBuilder", + "type": "Interface", + "label": "ExpressionAstExpressionBuilder", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionAstExpressionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48" + }, + "signature": [ + "\"expression_builder\"" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionAstExpressionBuilder.functions", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66" + }, + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]) => [] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-public.ExpressionAstExpressionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts expression to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstFunctionBuilder", + "type": "Interface", + "label": "ExpressionAstFunctionBuilder", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionAstFunctionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression function builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63" + }, + "signature": [ + "\"expression_function_builder\"" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionAstFunctionBuilder.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nName of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionAstFunctionBuilder.arguments", + "type": "Object", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74" + }, + "signature": [ + "FunctionBuilderArguments" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86" + }, + "signature": [ + ">(name: A, value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99" + }, + "signature": [ + ">(name: A) => (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[] | undefined" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111" + }, + "signature": [ + ">(name: A, value: (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]) => this" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124" + }, + "signature": [ + ">>(name: A) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-public.ExpressionAstFunctionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts function to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunctionDefinition", + "type": "Interface", + "label": "ExpressionFunctionDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + " extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">>" + ], + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nThe name of the function, as will be used in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [ + "\nif set to true function will be disabled (but its migrate function will still be available)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.type", + "type": "CompoundType", + "label": "type", + "description": [ + "\nName of type of value this function outputs." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "<", + "UnwrapPromiseOrReturn", + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.inputTypes", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypeToString", + "text": "TypeToString" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.args", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64" + }, + "signature": [ + "{ [key in keyof Arguments]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "; }" + ] + }, + { + "tags": [ + "todo" + ], + "id": "def-public.ExpressionFunctionDefinition.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75" + } + }, + { + "id": "def-public.ExpressionFunctionDefinition.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "description": [ + "\nThe actual implementation of the function.\n" + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Output of the previous function, or initial input." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [ + "Parameters set for this function in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.ExpressionFunctionDefinition.context", + "type": "Object", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91" + }, + "signature": [ + "{ types: any[] | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunctionDefinitions", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.clog", + "type": "Object", + "label": "clog", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.font", + "type": "Object", + "label": "font", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.var_set", + "type": "Object", + "label": "var_set", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.var", + "type": "Object", + "label": "var", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.theme", + "type": "Object", + "label": "theme", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.cumulative_sum", + "type": "Object", + "label": "cumulative_sum", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.derivative", + "type": "Object", + "label": "derivative", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunctionDefinitions.moving_average", + "type": "Object", + "label": "moving_average", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionImage", + "type": "Interface", + "label": "ExpressionImage", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionImage.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15" + }, + "signature": [ + "\"image\"" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionImage.mode", + "type": "string", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.ExpressionImage.dataurl", + "type": "string", + "label": "dataurl", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionRenderDefinition", + "type": "Interface", + "label": "ExpressionRenderDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.name", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.displayName", + "type": "string", + "label": "displayName", + "description": [ + "\nA user friendly name of the renderer as will be displayed to user in UI." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nUsed to validate the data before calling the render function." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31" + }, + "signature": [ + "(() => Error | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [ + "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-public.ExpressionRenderDefinition.render", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionTypeDefinition", + "type": "Interface", + "label": "ExpressionTypeDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" + ], + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32" + }, + "signature": [ + "((type: any) => void | Error) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.serialize", + "type": "Function", + "label": "serialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33" + }, + "signature": [ + "((type: Value) => SerializedType) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34" + }, + "signature": [ + "((type: SerializedType) => Value) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.from", + "type": "Object", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.to", + "type": "Object", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeDefinition.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionTypeStyle", + "type": "Interface", + "label": "ExpressionTypeStyle", + "description": [ + "\nAn object that represents style information, typically CSS." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionTypeStyle.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121" + }, + "signature": [ + "\"style\"" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeStyle.spec", + "type": "Object", + "label": "spec", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CSSStyle", + "text": "CSSStyle" + } + ] + }, + { + "tags": [], + "id": "def-public.ExpressionTypeStyle.css", + "type": "string", + "label": "css", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Font", + "type": "Interface", + "label": "Font", + "description": [ + "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Font.label", + "type": "CompoundType", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26" + }, + "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\"" + ] + }, + { + "tags": [], + "id": "def-public.Font.value", + "type": "CompoundType", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27" + }, + "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": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IInterpreterRenderHandlers", + "type": "Interface", + "label": "IInterpreterRenderHandlers", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.done", + "type": "Function", + "label": "done", + "description": [ + "\nDone increments the number of rendering successes" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.onDestroy", + "type": "Function", + "label": "onDestroy", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68" + }, + "signature": [ + "(fn: () => void) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.reload", + "type": "Function", + "label": "reload", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70" + }, + "signature": [ + "(params: any) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.event", + "type": "Function", + "label": "event", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71" + }, + "signature": [ + "(event: any) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72" + }, + "signature": [ + "((event: any) => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.getRenderMode", + "type": "Function", + "label": "getRenderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.RenderMode", + "text": "RenderMode" + } + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.uiState", + "type": "Unknown", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IRegistry", + "type": "Interface", + "label": "IRegistry", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.IRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => T | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + }, + { + "id": "def-public.IRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12" + } + }, + { + "id": "def-public.IRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => T[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PointSeriesColumn", + "type": "Interface", + "label": "PointSeriesColumn", + "description": [ + "\nColumn in a PointSeries" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PointSeriesColumn.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24" + }, + "signature": [ + "\"string\" | \"number\"" + ] + }, + { + "tags": [], + "id": "def-public.PointSeriesColumn.role", + "type": "CompoundType", + "label": "role", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25" + }, + "signature": [ + "\"measure\" | \"dimension\"" + ] + }, + { + "tags": [], + "id": "def-public.PointSeriesColumn.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Range", + "type": "Interface", + "label": "Range", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Range.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15" + }, + "signature": [ + "\"range\"" + ] + }, + { + "tags": [], + "id": "def-public.Range.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.Range.to", + "type": "number", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.Range.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SerializedDatatable", + "type": "Interface", + "label": "SerializedDatatable", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SerializedDatatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105" + }, + "signature": [ + "string[][]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SerializedFieldFormat", + "type": "Interface", + "label": "SerializedFieldFormat", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SerializedFieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SerializedFieldFormat.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55" + }, + "signature": [ + "TParams | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionsServiceStart", + "type": "Interface", + "label": "ExpressionsServiceStart", + "description": [ + "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.getFunction", + "type": "Function", + "label": "getFunction", + "description": [ + "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L78" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.getRenderer", + "type": "Function", + "label": "getRenderer", + "description": [ + "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L86" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.getType", + "type": "Function", + "label": "getType", + "description": [ + "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L94" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.run", + "type": "Function", + "label": "run", + "description": [ + "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L120" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.execute", + "type": "Function", + "label": "execute", + "description": [ + "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L131" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsServiceStart.fork", + "type": "Function", + "label": "fork", + "description": [ + "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L147" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L71" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.FontStyle", + "type": "Enum", + "label": "FontStyle", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-style` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FontWeight", + "type": "Enum", + "label": "FontWeight", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-weight` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Overflow", + "type": "Enum", + "label": "Overflow", + "tags": [], + "description": [ + "\nEnum of supported CSS `overflow` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TextAlignment", + "type": "Enum", + "label": "TextAlignment", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-align` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TextDecoration", + "type": "Enum", + "label": "TextDecoration", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-decoration` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.ExpressionRendererComponent", + "type": "Type", + "label": "ExpressionRendererComponent", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L49" + }, + "signature": [ + "(props: React.PropsWithChildren<", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + }, + ">, context: any) => React.ReactElement | null" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ReactExpressionRendererType", + "type": "Type", + "label": "ReactExpressionRendererType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L41" + }, + "signature": [ + "React.ComponentClass<", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + }, + ", any> | React.FunctionComponent<", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ReactExpressionRendererProps", + "text": "ReactExpressionRendererProps" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AnyExpressionFunctionDefinition", + "type": "Type", + "label": "AnyExpressionFunctionDefinition", + "tags": [], + "description": [ + "\nType to capture every possible expression function definition." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102" + }, + "signature": [ + "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AnyExpressionTypeDefinition", + "type": "Type", + "label": "AnyExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46" + }, + "signature": [ + "ExpressionTypeDefinition" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ArgumentType", + "type": "Type", + "label": "ArgumentType", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/arguments.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16" + }, + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], + "initialIsOpen": false + }, + { + "id": "def-public.DatatableColumnType", + "type": "Type", + "label": "DatatableColumnType", + "tags": [], + "description": [ + "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.DatatableRow", + "type": "Type", + "label": "DatatableRow", + "tags": [], + "description": [ + "\nThis type represents a row in a `Datatable`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExecutionContainer", + "type": "Type", + "label": "ExecutionContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73" + }, + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExecutorContainer", + "type": "Type", + "label": "ExecutorContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55" + }, + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstArgument", + "type": "Type", + "label": "ExpressionAstArgument", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstExpression", + "type": "Type", + "label": "ExpressionAstExpression", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16" + }, + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstFunction", + "type": "Type", + "label": "ExpressionAstFunction", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21" + }, + "signature": [ + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionAstNode", + "type": "Type", + "label": "ExpressionAstNode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValue", + "type": "Type", + "label": "ExpressionValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueBoxed", + "type": "Type", + "label": "ExpressionValueBoxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11" + }, + "signature": [ + "{ type: Type; } & Value" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueConverter", + "type": "Type", + "label": "ExpressionValueConverter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17" + }, + "signature": [ + "(input: I, availableTypes: Record) => O" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueError", + "type": "Type", + "label": "ExpressionValueError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueNum", + "type": "Type", + "label": "ExpressionValueNum", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14" + }, + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueUnboxed", + "type": "Type", + "label": "ExpressionValueUnboxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14" + }, + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FontLabel", + "type": "Type", + "label": "FontLabel", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FontValue", + "type": "Type", + "label": "FontValue", + "tags": [], + "description": [ + "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.InterpreterErrorType", + "type": "Type", + "label": "InterpreterErrorType", + "tags": [ + "deprecated" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.KnownTypeToString", + "type": "Type", + "label": "KnownTypeToString", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26" + }, + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PointSeries", + "type": "Type", + "label": "PointSeries", + "tags": [], + "description": [ + "\nA `PointSeries` is a unique structure that represents dots on a chart." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39" + }, + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PointSeriesColumnName", + "type": "Type", + "label": "PointSeriesColumnName", + "tags": [], + "description": [ + "\nAllowed column names in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18" + }, + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PointSeriesColumns", + "type": "Type", + "label": "PointSeriesColumns", + "tags": [], + "description": [ + "\nRepresents a collection of valid Columns in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32" + }, + "signature": [ + "{} | Record<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumnName", + "text": "PointSeriesColumnName" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumn", + "text": "PointSeriesColumn" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PointSeriesRow", + "type": "Type", + "label": "PointSeriesRow", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.Style", + "type": "Type", + "label": "Style", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126" + }, + "signature": [ + "ExpressionTypeStyle" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TypeString", + "type": "Type", + "label": "TypeString", + "tags": [], + "description": [ + "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39" + }, + "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" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TypeToString", + "type": "Type", + "label": "TypeToString", + "tags": [], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-public.UnmappedTypeStrings", + "type": "Type", + "label": "UnmappedTypeStrings", + "tags": [], + "description": [ + "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46" + }, + "signature": [ + "\"date\" | \"filter\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.ExpressionsSetup", + "type": "Type", + "label": "ExpressionsSetup", + "tags": [], + "description": [ + "\nExpressions public setup contract, extends {@link ExpressionsServiceSetup}" + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L24" + }, + "signature": [ + "{ readonly getType: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined; readonly getFunction: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null; readonly getRenderers: () => Record JSX.Element" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionsStart.render", + "type": "Function", + "label": "render", + "description": [], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L34" + }, + "signature": [ + "typeof ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.render", + "text": "render" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L29" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "id": "def-server.ExpressionsServerPlugin", + "type": "Class", + "tags": [], + "label": "ExpressionsServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "server", + "docId": "kibExpressionsPluginApi", + "section": "def-server.ExpressionsServerPlugin", + "text": "ExpressionsServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + }, + ", object, object>" + ], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionsServerPlugin.expressions", + "type": "Object", + "label": "expressions", + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L18" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] + }, + { + "id": "def-server.ExpressionsServerPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ") => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L38" + } + } + ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Execution", + "type": "Class", + "tags": [], + "label": "Execution", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-server.Execution.state", + "type": "Object", + "label": "state", + "description": [ + "\nDynamic state of the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.Execution.input", + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88" + }, + "signature": [ + "Input" + ] + }, + { + "tags": [], + "id": "def-server.Execution.context", + "type": "Object", + "label": "context", + "description": [ + "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.Execution.contract", + "type": "Object", + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140" + } + }, + { + "id": "def-server.Execution.result", + "type": "Object", + "label": "result", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142" + }, + "signature": [ + "Promise>" + ] + }, + { + "id": "def-server.Execution.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "id": "def-server.Execution.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "execution", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionParams", + "text": "ExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + }, + { + "id": "def-server.Execution.cancel", + "type": "Function", + "label": "cancel", + "signature": [ + "() => void" + ], + "description": [ + "\nStop execution of expression." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192" + } + }, + { + "id": "def-server.Execution.start", + "type": "Function", + "label": "start", + "signature": [ + "(input?: Input) => void" + ], + "description": [ + "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + }, + { + "id": "def-server.Execution.invokeChain", + "type": "Function", + "label": "invokeChain", + "signature": [ + "(chainArr: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[], input: unknown) => Promise" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "chainArr", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "id": "def-server.Execution.invokeFunction", + "type": "Function", + "label": "invokeFunction", + "signature": [ + "(fn: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, args: Record) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fn", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 318, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 316, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316" + } + }, + { + "id": "def-server.Execution.cast", + "type": "Function", + "label": "cast", + "signature": [ + "(value: any, toTypeNames?: string[] | undefined) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "type": "Array", + "label": "toTypeNames", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "id": "def-server.Execution.resolveArgs", + "type": "Function", + "label": "resolveArgs", + "signature": [ + "(fnDef: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, argAsts: any) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fnDef", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Any", + "label": "argAsts", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "id": "def-server.Execution.interpret", + "type": "Function", + "label": "interpret", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + }, + ", input: T) => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Executor", + "type": "Class", + "tags": [], + "label": "Executor", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ">" + ], + "children": [ + { + "id": "def-server.Executor.createWithDefaults", + "type": "Function", + "label": "createWithDefaults", + "signature": [ + "typeof ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ".createWithDefaults" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82" + } + }, + { + "tags": [], + "id": "def-server.Executor.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" + }, + "" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.Executor.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + } + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.Executor.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + } + ] + }, + { + "id": "def-server.Executor.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + }, + { + "id": "def-server.Executor.registerFunction", + "type": "Function", + "label": "registerFunction", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109" + } + }, + { + "id": "def-server.Executor.getFunction", + "type": "Function", + "label": "getFunction", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + }, + { + "id": "def-server.Executor.getFunctions", + "type": "Function", + "label": "getFunctions", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122" + } + }, + { + "id": "def-server.Executor.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126" + } + }, + { + "id": "def-server.Executor.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + }, + { + "id": "def-server.Executor.getTypes", + "type": "Function", + "label": "getTypes", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139" + } + }, + { + "id": "def-server.Executor.extendContext", + "type": "Function", + "label": "extendContext", + "signature": [ + "(extraContext: Record) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "extraContext", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + }, + { + "id": "def-server.Executor.context", + "type": "Object", + "label": "context", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-server.Executor.run", + "type": "Function", + "label": "run", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => Promise" + ], + "description": [ + "\nExecute expression and return result.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression AST or a string representing expression." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Initial input to the first expression function." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159" + } + }, + { + "id": "def-server.Executor.createExecution", + "type": "Function", + "label": "createExecution", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169" + } + }, + { + "id": "def-server.Executor.inject", + "type": "Function", + "label": "inject", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "id": "def-server.Executor.extract", + "type": "Function", + "label": "extract", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + }, + { + "id": "def-server.Executor.telemetry", + "type": "Function", + "label": "telemetry", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData: Record) => Record" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "id": "def-server.Executor.migrate", + "type": "Function", + "label": "migrate", + "signature": [ + "(ast: ", + { + "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" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "id": "def-server.Executor.fork", + "type": "Function", + "label": "fork", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunction", + "type": "Class", + "tags": [], + "label": "ExpressionFunction", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionFunction.name", + "type": "string", + "label": "name", + "description": [ + "\nName of function" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.aliases", + "type": "Array", + "label": "aliases", + "description": [ + "\nAliases that can be used instead of `name`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.type", + "type": "string", + "label": "type", + "description": [ + "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.fn", + "type": "Function", + "label": "fn", + "description": [ + "\nFunction to run function (context, args)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39" + }, + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44" + } + }, + { + "id": "def-server.ExpressionFunction.args", + "type": "Object", + "tags": [], + "children": [], + "description": [ + "\nSpecification of expression function parameters." + ], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [ + "\nType of inputs that this function supports." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.disabled", + "type": "boolean", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.telemetry", + "type": "Function", + "label": "telemetry", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57" + }, + "signature": [ + "(state: Record, telemetryData: Record) => Record" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61" + }, + "signature": [ + "(state: Record) => { state: Record; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.inject", + "type": "Function", + "label": "inject", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64" + }, + "signature": [ + "(state: Record, references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => Record" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunction.migrations", + "type": "Object", + "label": "migrations", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68" + }, + "signature": [ + "{ [key: string]: (state: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ") => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + "; }" + ] + }, + { + "id": "def-server.ExpressionFunction.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + }, + { + "id": "def-server.ExpressionFunction.accepts", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + } + } + ], + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "label": "accepts", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionParameter", + "type": "Class", + "tags": [], + "label": "ExpressionFunctionParameter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.resolve", + "type": "boolean", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19" + } + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionParameter.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20" + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-server.ExpressionFunctionParameter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "arg", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "id": "def-server.ExpressionFunctionParameter.accepts", + "type": "Function", + "label": "accepts", + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionRenderer", + "type": "Class", + "tags": [], + "label": "ExpressionRenderer", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionRenderer.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderer.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderer.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderer.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15" + }, + "signature": [ + "() => void | Error" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionRenderer.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderer.render", + "type": "Function", + "label": "render", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + }, + { + "id": "def-server.ExpressionRenderer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionRendererRegistry", + "type": "Class", + "tags": [], + "label": "ExpressionRendererRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + ">" + ], + "children": [ + { + "id": "def-server.ExpressionRendererRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + }, + { + "id": "def-server.ExpressionRendererRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + }, + { + "id": "def-server.ExpressionRendererRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29" + } + }, + { + "id": "def-server.ExpressionRendererRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionType", + "type": "Class", + "tags": [], + "label": "ExpressionType", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.ExpressionType.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L18" + } + }, + { + "tags": [], + "id": "def-server.ExpressionType.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nType validation, useful for checking function output." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L23" + }, + "signature": [ + "(type: any) => void | Error" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionType.serialize", + "type": "Function", + "label": "serialize", + "description": [ + "\nOptional serialization (used when passing context around client/server)." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30" + }, + "signature": [ + "((value: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31" + }, + "signature": [ + "((serialized: any) => any) | undefined" + ] + }, + { + "id": "def-server.ExpressionType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + }, + { + "id": "def-server.ExpressionType.getToFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getToFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.getFromFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getFromFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.castsTo", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsTo", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.castsFrom", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsFrom", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.to", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "string", + "label": "toTypeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + } + ], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.from", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + } + ], + "signature": [ + "(value: any, types: Record) => any" + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FunctionsRegistry", + "type": "Class", + "tags": [], + "label": "FunctionsRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ">" + ], + "children": [ + { + "id": "def-server.FunctionsRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + }, + { + "id": "def-server.FunctionsRegistry.register", + "type": "Function", + "label": "register", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61" + } + }, + { + "id": "def-server.FunctionsRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + }, + { + "id": "def-server.FunctionsRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71" + } + }, + { + "id": "def-server.FunctionsRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-server.TypesRegistry", + "type": "Class", + "tags": [], + "label": "TypesRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ">" + ], + "children": [ + { + "id": "def-server.TypesRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + }, + { + "id": "def-server.TypesRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39" + } + }, + { + "id": "def-server.TypesRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + }, + { + "id": "def-server.TypesRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49" + } + }, + { + "id": "def-server.TypesRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionsServerPlugin", + "type": "Class", + "tags": [], + "label": "ExpressionsServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "server", + "docId": "kibExpressionsPluginApi", + "section": "def-server.ExpressionsServerPlugin", + "text": "ExpressionsServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + }, + ", object, object>" + ], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionsServerPlugin.expressions", + "type": "Object", + "label": "expressions", + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L18" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] + }, + { + "id": "def-server.ExpressionsServerPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ") => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32" + } + }, + { + "id": "def-server.ExpressionsServerPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L38" + } + } + ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L16" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-server.buildExpression", + "type": "Function", + "label": "buildExpression", + "signature": [ + "(initialState: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "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" + ], + "children": [ + { + "type": "CompoundType", + "label": "initialState", + "isRequired": false, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined" + ], + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-server.buildExpressionFunction", + "type": "Function", + "label": "buildExpressionFunction", + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "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" + ], + "children": [ + { + "type": "Uncategorized", + "label": "fnName", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "description": [ + "String representing the name of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155" + } + }, + { + "type": "Object", + "label": "initialArgs", + "isRequired": true, + "signature": [ + "{ [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }" + ], + "description": [ + "Object containing the arguments to this function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152" + }, + "initialIsOpen": false + }, + { + "id": "def-server.format", + "type": "Function", + "label": "format", + "signature": [ + "(ast: T, type: T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\") => string" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "ast", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "type", + "isRequired": true, + "signature": [ + "T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\"" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.formatExpression", + "type": "Function", + "label": "formatExpression", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => string" + ], + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression pipeline AST." + ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.isExpressionAstBuilder", + "type": "Function", + "label": "isExpressionAstBuilder", + "signature": [ + "(val: any) => boolean" + ], + "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" + ], + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "Value you want to check." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + } + } + ], + "tags": [ + "example", + "return" + ], + "returnComment": [ + "boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-server.parse", + "type": "Function", + "label": "parse", + "signature": [ + "(expression: E, startRule: S) => S extends \"expression\" ? ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " : ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + } + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "expression", + "isRequired": true, + "signature": [ + "E" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "startRule", + "isRequired": true, + "signature": [ + "S" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.parseExpression", + "type": "Function", + "label": "parseExpression", + "signature": [ + "(expression: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], + "children": [ + { + "type": "string", + "label": "expression", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Expression pipeline string." + ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.Datatable", + "type": "Interface", + "label": "Datatable", + "description": [ + "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.Datatable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-server.Datatable.columns", + "type": "Array", + "label": "columns", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.Datatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101" + }, + "signature": [ + "Record[]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DatatableColumn", + "type": "Interface", + "label": "DatatableColumn", + "description": [ + "\nThis type represents the shape of a column in a `Datatable`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.DatatableColumn.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90" + } + }, + { + "tags": [], + "id": "def-server.DatatableColumn.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91" + } + }, + { + "tags": [], + "id": "def-server.DatatableColumn.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnMeta", + "text": "DatatableColumnMeta" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExecutionContext", + "type": "Interface", + "label": "ExecutionContext", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ], + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExecutionContext.getSearchContext", + "type": "Function", + "label": "getSearchContext", + "description": [ + "\nGet search context of the expression." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28" + }, + "signature": [ + "() => ExecutionContextSearch" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.variables", + "type": "Object", + "label": "variables", + "description": [ + "\nContext variables that can be consumed using `var` and `var_set` functions." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.types", + "type": "Object", + "label": "types", + "description": [ + "\nA map of available expression types." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAdds ability to abort current execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43" + }, + "signature": [ + "AbortSignal" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "description": [ + "\nAdapters for `inspector` plugin." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.getSearchSessionId", + "type": "Function", + "label": "getSearchSessionId", + "description": [ + "\nSearch context in which expression should operate." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53" + }, + "signature": [ + "() => string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.getKibanaRequest", + "type": "Function", + "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": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60" + }, + "signature": [ + "(() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.getSavedObject", + "type": "Function", + "label": "getSavedObject", + "description": [ + "\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71" + }, + "signature": [ + "((type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionContext.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync colors across panels switch." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79" + }, + "signature": [ + "(() => boolean) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExecutionParams", + "type": "Interface", + "label": "ExecutionParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExecutionParams.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionParams.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionParams.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionParams.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExecutionState", + "type": "Interface", + "label": "ExecutionState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExecutionState.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [], + "id": "def-server.ExecutionState.state", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28" + }, + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionState.result", + "type": "Uncategorized", + "label": "result", + "description": [ + "\nResult of the expression execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33" + }, + "signature": [ + "Output | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExecutionState.error", + "type": "Object", + "label": "error", + "description": [ + "\nError happened during the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExecutorState", + "type": "Interface", + "label": "ExecutorState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExecutorState.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.ExecutorState.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.ExecutorState.context", + "type": "Uncategorized", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19" + }, + "signature": [ + "Context" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstExpressionBuilder", + "type": "Interface", + "label": "ExpressionAstExpressionBuilder", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionAstExpressionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48" + }, + "signature": [ + "\"expression_builder\"" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionAstExpressionBuilder.functions", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66" + }, + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]) => [] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-server.ExpressionAstExpressionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts expression to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstFunctionBuilder", + "type": "Interface", + "label": "ExpressionAstFunctionBuilder", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionAstFunctionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression function builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63" + }, + "signature": [ + "\"expression_function_builder\"" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionAstFunctionBuilder.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nName of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionAstFunctionBuilder.arguments", + "type": "Object", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74" + }, + "signature": [ + "FunctionBuilderArguments" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86" + }, + "signature": [ + ">(name: A, value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99" + }, + "signature": [ + ">(name: A) => (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[] | undefined" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111" + }, + "signature": [ + ">(name: A, value: (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]) => this" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124" + }, + "signature": [ + ">>(name: A) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-server.ExpressionAstFunctionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts function to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionDefinition", + "type": "Interface", + "label": "ExpressionFunctionDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + " extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">>" + ], + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nThe name of the function, as will be used in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [ + "\nif set to true function will be disabled (but its migrate function will still be available)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.type", + "type": "CompoundType", + "label": "type", + "description": [ + "\nName of type of value this function outputs." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "<", + "UnwrapPromiseOrReturn", + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.inputTypes", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypeToString", + "text": "TypeToString" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.args", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64" + }, + "signature": [ + "{ [key in keyof Arguments]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "; }" + ] + }, + { + "tags": [ + "todo" + ], + "id": "def-server.ExpressionFunctionDefinition.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75" + } + }, + { + "id": "def-server.ExpressionFunctionDefinition.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "description": [ + "\nThe actual implementation of the function.\n" + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Output of the previous function, or initial input." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [ + "Parameters set for this function in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "tags": [ + "deprecated" + ], + "id": "def-server.ExpressionFunctionDefinition.context", + "type": "Object", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91" + }, + "signature": [ + "{ types: any[] | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionDefinitions", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.clog", + "type": "Object", + "label": "clog", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.font", + "type": "Object", + "label": "font", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.var_set", + "type": "Object", + "label": "var_set", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.var", + "type": "Object", + "label": "var", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.theme", + "type": "Object", + "label": "theme", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.cumulative_sum", + "type": "Object", + "label": "cumulative_sum", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.derivative", + "type": "Object", + "label": "derivative", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionFunctionDefinitions.moving_average", + "type": "Object", + "label": "moving_average", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionImage", + "type": "Interface", + "label": "ExpressionImage", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionImage.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15" + }, + "signature": [ + "\"image\"" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionImage.mode", + "type": "string", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16" + } + }, + { + "tags": [], + "id": "def-server.ExpressionImage.dataurl", + "type": "string", + "label": "dataurl", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionRenderDefinition", + "type": "Interface", + "label": "ExpressionRenderDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.name", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.displayName", + "type": "string", + "label": "displayName", + "description": [ + "\nA user friendly name of the renderer as will be displayed to user in UI." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nUsed to validate the data before calling the render function." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31" + }, + "signature": [ + "(() => Error | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [ + "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-server.ExpressionRenderDefinition.render", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionTypeDefinition", + "type": "Interface", + "label": "ExpressionTypeDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" + ], + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32" + }, + "signature": [ + "((type: any) => void | Error) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.serialize", + "type": "Function", + "label": "serialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33" + }, + "signature": [ + "((type: Value) => SerializedType) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34" + }, + "signature": [ + "((type: SerializedType) => Value) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.from", + "type": "Object", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.to", + "type": "Object", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeDefinition.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionTypeStyle", + "type": "Interface", + "label": "ExpressionTypeStyle", + "description": [ + "\nAn object that represents style information, typically CSS." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ExpressionTypeStyle.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121" + }, + "signature": [ + "\"style\"" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeStyle.spec", + "type": "Object", + "label": "spec", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CSSStyle", + "text": "CSSStyle" + } + ] + }, + { + "tags": [], + "id": "def-server.ExpressionTypeStyle.css", + "type": "string", + "label": "css", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Font", + "type": "Interface", + "label": "Font", + "description": [ + "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.Font.label", + "type": "CompoundType", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26" + }, + "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\"" + ] + }, + { + "tags": [], + "id": "def-server.Font.value", + "type": "CompoundType", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27" + }, + "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": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IInterpreterRenderHandlers", + "type": "Interface", + "label": "IInterpreterRenderHandlers", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.done", + "type": "Function", + "label": "done", + "description": [ + "\nDone increments the number of rendering successes" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.onDestroy", + "type": "Function", + "label": "onDestroy", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68" + }, + "signature": [ + "(fn: () => void) => void" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.reload", + "type": "Function", + "label": "reload", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70" + }, + "signature": [ + "(params: any) => void" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.event", + "type": "Function", + "label": "event", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71" + }, + "signature": [ + "(event: any) => void" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72" + }, + "signature": [ + "((event: any) => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.getRenderMode", + "type": "Function", + "label": "getRenderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.RenderMode", + "text": "RenderMode" + } + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-server.IInterpreterRenderHandlers.uiState", + "type": "Unknown", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IRegistry", + "type": "Interface", + "label": "IRegistry", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.IRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => T | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + }, + { + "id": "def-server.IRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12" + } + }, + { + "id": "def-server.IRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => T[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PointSeriesColumn", + "type": "Interface", + "label": "PointSeriesColumn", + "description": [ + "\nColumn in a PointSeries" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.PointSeriesColumn.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24" + }, + "signature": [ + "\"string\" | \"number\"" + ] + }, + { + "tags": [], + "id": "def-server.PointSeriesColumn.role", + "type": "CompoundType", + "label": "role", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25" + }, + "signature": [ + "\"measure\" | \"dimension\"" + ] + }, + { + "tags": [], + "id": "def-server.PointSeriesColumn.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Range", + "type": "Interface", + "label": "Range", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.Range.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15" + }, + "signature": [ + "\"range\"" + ] + }, + { + "tags": [], + "id": "def-server.Range.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16" + } + }, + { + "tags": [], + "id": "def-server.Range.to", + "type": "number", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17" + } + }, + { + "tags": [], + "id": "def-server.Range.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SerializedDatatable", + "type": "Interface", + "label": "SerializedDatatable", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SerializedDatatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105" + }, + "signature": [ + "string[][]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SerializedFieldFormat", + "type": "Interface", + "label": "SerializedFieldFormat", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SerializedFieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SerializedFieldFormat.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55" + }, + "signature": [ + "TParams | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-server.FontStyle", + "type": "Enum", + "label": "FontStyle", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-style` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FontWeight", + "type": "Enum", + "label": "FontWeight", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-weight` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Overflow", + "type": "Enum", + "label": "Overflow", + "tags": [], + "description": [ + "\nEnum of supported CSS `overflow` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-server.TextAlignment", + "type": "Enum", + "label": "TextAlignment", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-align` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72" + }, + "initialIsOpen": false + }, + { + "id": "def-server.TextDecoration", + "type": "Enum", + "label": "TextDecoration", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-decoration` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-server.AnyExpressionFunctionDefinition", + "type": "Type", + "label": "AnyExpressionFunctionDefinition", + "tags": [], + "description": [ + "\nType to capture every possible expression function definition." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102" + }, + "signature": [ + "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.AnyExpressionTypeDefinition", + "type": "Type", + "label": "AnyExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46" + }, + "signature": [ + "ExpressionTypeDefinition" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ArgumentType", + "type": "Type", + "label": "ArgumentType", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/arguments.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16" + }, + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], + "initialIsOpen": false + }, + { + "id": "def-server.DatatableColumnType", + "type": "Type", + "label": "DatatableColumnType", + "tags": [], + "description": [ + "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.DatatableRow", + "type": "Type", + "label": "DatatableRow", + "tags": [], + "description": [ + "\nThis type represents a row in a `Datatable`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExecutionContainer", + "type": "Type", + "label": "ExecutionContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73" + }, + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExecutorContainer", + "type": "Type", + "label": "ExecutorContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55" + }, + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstArgument", + "type": "Type", + "label": "ExpressionAstArgument", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstExpression", + "type": "Type", + "label": "ExpressionAstExpression", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16" + }, + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstFunction", + "type": "Type", + "label": "ExpressionAstFunction", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21" + }, + "signature": [ + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionAstNode", + "type": "Type", + "label": "ExpressionAstNode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValue", + "type": "Type", + "label": "ExpressionValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueBoxed", + "type": "Type", + "label": "ExpressionValueBoxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11" + }, + "signature": [ + "{ type: Type; } & Value" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueConverter", + "type": "Type", + "label": "ExpressionValueConverter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17" + }, + "signature": [ + "(input: I, availableTypes: Record) => O" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueError", + "type": "Type", + "label": "ExpressionValueError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueNum", + "type": "Type", + "label": "ExpressionValueNum", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14" + }, + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueUnboxed", + "type": "Type", + "label": "ExpressionValueUnboxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14" + }, + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.FontLabel", + "type": "Type", + "label": "FontLabel", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.FontValue", + "type": "Type", + "label": "FontValue", + "tags": [], + "description": [ + "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.InterpreterErrorType", + "type": "Type", + "label": "InterpreterErrorType", + "tags": [ + "deprecated" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.KnownTypeToString", + "type": "Type", + "label": "KnownTypeToString", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26" + }, + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PointSeries", + "type": "Type", + "label": "PointSeries", + "tags": [], + "description": [ + "\nA `PointSeries` is a unique structure that represents dots on a chart." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39" + }, + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PointSeriesColumnName", + "type": "Type", + "label": "PointSeriesColumnName", + "tags": [], + "description": [ + "\nAllowed column names in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18" + }, + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PointSeriesColumns", + "type": "Type", + "label": "PointSeriesColumns", + "tags": [], + "description": [ + "\nRepresents a collection of valid Columns in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32" + }, + "signature": [ + "{} | Record<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumnName", + "text": "PointSeriesColumnName" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumn", + "text": "PointSeriesColumn" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PointSeriesRow", + "type": "Type", + "label": "PointSeriesRow", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.Style", + "type": "Type", + "label": "Style", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126" + }, + "signature": [ + "ExpressionTypeStyle" + ], + "initialIsOpen": false + }, + { + "id": "def-server.TypeString", + "type": "Type", + "label": "TypeString", + "tags": [], + "description": [ + "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39" + }, + "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" + ], + "initialIsOpen": false + }, + { + "id": "def-server.TypeToString", + "type": "Type", + "label": "TypeToString", + "tags": [], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.UnmappedTypeStrings", + "type": "Type", + "label": "UnmappedTypeStrings", + "tags": [], + "description": [ + "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46" + }, + "signature": [ + "\"date\" | \"filter\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.ExpressionsServerSetup", + "type": "Type", + "label": "ExpressionsServerSetup", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L12" + }, + "signature": [ + "{ readonly getType: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined; readonly getFunction: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null; readonly getRenderers: () => Record void | Error" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25" + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionType.serialize", + "type": "Function", + "label": "serialize", + "description": [ + "\nOptional serialization (used when passing context around client/server)." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30" + }, + "signature": [ + "((value: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31" + }, + "signature": [ + "((serialized: any) => any) | undefined" + ] + }, + { + "id": "def-common.ExpressionType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33" + } + }, + { + "id": "def-common.ExpressionType.getToFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getToFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionType.getFromFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53" + } + } + ], + "signature": [ + "(typeName: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" + ], + "description": [], + "label": "getFromFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionType.castsTo", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsTo", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionType.castsFrom", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsFrom", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionType.to", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "string", + "label": "toTypeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + } + } + ], + "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionType.from", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + } + } + ], + "signature": [ + "(value: any, types: Record) => any" + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionParameter", + "type": "Class", + "tags": [], + "label": "ExpressionFunctionParameter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.resolve", + "type": "boolean", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20" + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-common.ExpressionFunctionParameter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "arg", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22" + } + }, + { + "id": "def-common.ExpressionFunctionParameter.accepts", + "type": "Function", + "label": "accepts", + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunction", + "type": "Class", + "tags": [], + "label": "ExpressionFunction", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionFunction.name", + "type": "string", + "label": "name", + "description": [ + "\nName of function" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.aliases", + "type": "Array", + "label": "aliases", + "description": [ + "\nAliases that can be used instead of `name`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.type", + "type": "string", + "label": "type", + "description": [ + "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.fn", + "type": "Function", + "label": "fn", + "description": [ + "\nFunction to run function (context, args)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39" + }, + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44" + } + }, + { + "id": "def-common.ExpressionFunction.args", + "type": "Object", + "tags": [], + "children": [], + "description": [ + "\nSpecification of expression function parameters." + ], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [ + "\nType of inputs that this function supports." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.disabled", + "type": "boolean", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.telemetry", + "type": "Function", + "label": "telemetry", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57" + }, + "signature": [ + "(state: Record, telemetryData: Record) => Record" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61" + }, + "signature": [ + "(state: Record) => { state: Record; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.inject", + "type": "Function", + "label": "inject", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64" + }, + "signature": [ + "(state: Record, references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => Record" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.migrations", + "type": "Object", + "label": "migrations", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68" + }, + "signature": [ + "{ [key: string]: (state: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ") => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + "; }" + ] + }, + { + "id": "def-common.ExpressionFunction.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72" + } + }, + { + "id": "def-common.ExpressionFunction.accepts", + "type": "Function", + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + } + } + ], + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "label": "accepts", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionRenderer", + "type": "Class", + "tags": [], + "label": "ExpressionRenderer", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionRenderer.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderer.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderer.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderer.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15" + }, + "signature": [ + "() => void | Error" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionRenderer.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderer.render", + "type": "Function", + "label": "render", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + }, + { + "id": "def-common.ExpressionRenderer.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionRendererRegistry", + "type": "Class", + "tags": [], + "label": "ExpressionRendererRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + ">" + ], + "children": [ + { + "id": "def-common.ExpressionRendererRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19" + } + }, + { + "id": "def-common.ExpressionRendererRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25" + } + }, + { + "id": "def-common.ExpressionRendererRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29" + } + }, + { + "id": "def-common.ExpressionRendererRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TypesRegistry", + "type": "Class", + "tags": [], + "label": "TypesRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ">" + ], + "children": [ + { + "id": "def-common.TypesRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37" + } + }, + { + "id": "def-common.TypesRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39" + } + }, + { + "id": "def-common.TypesRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45" + } + }, + { + "id": "def-common.TypesRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49" + } + }, + { + "id": "def-common.TypesRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FunctionsRegistry", + "type": "Class", + "tags": [], + "label": "FunctionsRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + }, + " implements ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ">" + ], + "children": [ + { + "id": "def-common.FunctionsRegistry.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "executor", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59" + } + }, + { + "id": "def-common.FunctionsRegistry.register", + "type": "Function", + "label": "register", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61" + } + }, + { + "id": "def-common.FunctionsRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67" + } + }, + { + "id": "def-common.FunctionsRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71" + } + }, + { + "id": "def-common.FunctionsRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Executor", + "type": "Class", + "tags": [], + "label": "Executor", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ">" + ], + "children": [ + { + "id": "def-common.Executor.createWithDefaults", + "type": "Function", + "label": "createWithDefaults", + "signature": [ + "typeof ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ".createWithDefaults" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82" + } + }, + { + "tags": [], + "id": "def-common.Executor.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" + }, + "" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.Executor.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + } + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.Executor.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + } + ] + }, + { + "id": "def-common.Executor.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103" + } + }, + { + "id": "def-common.Executor.registerFunction", + "type": "Function", + "label": "registerFunction", + "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" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109" + } + }, + { + "id": "def-common.Executor.getFunction", + "type": "Function", + "label": "getFunction", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + } + }, + { + "id": "def-common.Executor.getFunctions", + "type": "Function", + "label": "getFunctions", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122" + } + }, + { + "id": "def-common.Executor.registerType", + "type": "Function", + "label": "registerType", + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126" + } + }, + { + "id": "def-common.Executor.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135" + } + }, + { + "id": "def-common.Executor.getTypes", + "type": "Function", + "label": "getTypes", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139" + } + }, + { + "id": "def-common.Executor.extendContext", + "type": "Function", + "label": "extendContext", + "signature": [ + "(extraContext: Record) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "extraContext", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143" + } + }, + { + "id": "def-common.Executor.context", + "type": "Object", + "label": "context", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-common.Executor.run", + "type": "Function", + "label": "run", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => Promise" + ], + "description": [ + "\nExecute expression and return result.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression AST or a string representing expression." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Initial input to the first expression function." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 159, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159" + } + }, + { + "id": "def-common.Executor.createExecution", + "type": "Function", + "label": "createExecution", + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169" + } + }, + { + "id": "def-common.Executor.inject", + "type": "Function", + "label": "inject", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217" + } + }, + { + "id": "def-common.Executor.extract", + "type": "Function", + "label": "extract", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223" + } + }, + { + "id": "def-common.Executor.telemetry", + "type": "Function", + "label": "telemetry", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData: Record) => Record" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233" + } + }, + { + "id": "def-common.Executor.migrate", + "type": "Function", + "label": "migrate", + "signature": [ + "(ast: ", + { + "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" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241" + } + }, + { + "id": "def-common.Executor.fork", + "type": "Function", + "label": "fork", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Execution", + "type": "Class", + "tags": [], + "label": "Execution", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-common.Execution.state", + "type": "Object", + "label": "state", + "description": [ + "\nDynamic state of the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.Execution.input", + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88" + }, + "signature": [ + "Input" + ] + }, + { + "tags": [], + "id": "def-common.Execution.context", + "type": "Object", + "label": "context", + "description": [ + "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.Execution.contract", + "type": "Object", + "label": "contract", + "description": [ + "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140" + } + }, + { + "id": "def-common.Execution.result", + "type": "Object", + "label": "result", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142" + }, + "signature": [ + "Promise>" + ] + }, + { + "id": "def-common.Execution.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "id": "def-common.Execution.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "execution", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionParams", + "text": "ExecutionParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + } + }, + { + "id": "def-common.Execution.cancel", + "type": "Function", + "label": "cancel", + "signature": [ + "() => void" + ], + "description": [ + "\nStop execution of expression." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192" + } + }, + { + "id": "def-common.Execution.start", + "type": "Function", + "label": "start", + "signature": [ + "(input?: Input) => void" + ], + "description": [ + "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202" + } + }, + { + "id": "def-common.Execution.invokeChain", + "type": "Function", + "label": "invokeChain", + "signature": [ + "(chainArr: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[], input: unknown) => Promise" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "chainArr", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236" + } + }, + { + "id": "def-common.Execution.invokeFunction", + "type": "Function", + "label": "invokeFunction", + "signature": [ + "(fn: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, args: Record) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fn", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 318, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 316, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316" + } + }, + { + "id": "def-common.Execution.cast", + "type": "Function", + "label": "cast", + "signature": [ + "(value: any, toTypeNames?: string[] | undefined) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "type": "Array", + "label": "toTypeNames", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + } + }, + { + "id": "def-common.Execution.resolveArgs", + "type": "Function", + "label": "resolveArgs", + "signature": [ + "(fnDef: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, argAsts: any) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fnDef", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "type": "Any", + "label": "argAsts", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + } + }, + { + "id": "def-common.Execution.interpret", + "type": "Function", + "label": "interpret", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + }, + ", input: T) => Promise" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionContract", + "type": "Class", + "tags": [], + "label": "ExecutionContract", + "description": [ + "\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ], + "children": [ + { + "id": "def-common.ExecutionContract.isPending", + "type": "boolean", + "label": "isPending", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L18" + } + }, + { + "id": "def-common.ExecutionContract.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "execution", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24" + } + }, + { + "id": "def-common.ExecutionContract.cancel", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "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", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L31" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExecutionContract.getData", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", + { + "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; }> | Output>" + ], + "description": [ + "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." + ], + "label": "getData", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L40" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExecutionContract.getExpression", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "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", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L60" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExecutionContract.getAst", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nGet AST used to execute the expression." + ], + "label": "getAst", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L67" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExecutionContract.inspect", + "type": "Function", + "children": [], + "signature": [ + "() => InspectorAdapters" + ], + "description": [ + "\nGet Inspector adapters provided to all functions of expression through\nexecution context." + ], + "label": "inspect", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L73" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsService", + "type": "Class", + "tags": [], + "label": "ExpressionsService", + "description": [ + "\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`." + ], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + " implements ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ">" + ], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionsService.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L175" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsService.renderers", + "type": "Object", + "label": "renderers", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L176" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + } + ] + }, + { + "id": "def-common.ExpressionsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionServiceParams", + "text": "ExpressionServiceParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178" + } + }, + { + "id": "def-common.ExpressionsService.registerFunction", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "functionDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L219" + } + } + ], + "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" + ], + "description": [ + "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." + ], + "label": "registerFunction", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L218" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.registerType", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "typeDefinition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L223" + } + } + ], + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" + ], + "description": [], + "label": "registerType", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L222" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.registerRenderer", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "definition", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L227" + } + } + ], + "signature": [ + "(definition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" + }, + ")) => void" + ], + "description": [], + "label": "registerRenderer", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L226" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.run", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "ast", + "isRequired": true, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": false, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + } + } + ], + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise" + ], + "description": [], + "label": "run", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getFunction", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ], + "description": [], + "label": "getFunction", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getFunctions", + "type": "Function", + "children": [], + "signature": [ + "() => Record" + ], + "description": [ + "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." + ], + "label": "getFunctions", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L240" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getRenderer", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ], + "description": [], + "label": "getRenderer", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getRenderers", + "type": "Function", + "children": [], + "signature": [ + "() => Record>" + ], + "description": [ + "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." + ], + "label": "getRenderers", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L250" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getType", + "type": "Function", + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253" + } + } + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ], + "description": [], + "label": "getType", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.getTypes", + "type": "Function", + "children": [], + "signature": [ + "() => Record" + ], + "description": [ + "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." + ], + "label": "getTypes", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L260" + }, + "tags": [], + "returnComment": [] + }, + { + "tags": [], + "id": "def-common.ExpressionsService.execute", + "type": "Function", + "label": "execute", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L262" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ] + }, + { + "id": "def-common.ExpressionsService.fork", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ], + "description": [], + "label": "fork", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L268" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.telemetry", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L281" + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L282" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", telemetryData?: Record) => Record" + ], + "description": [ + "\nExtracts telemetry from expression AST" + ], + "label": "telemetry", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 280, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L280" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.extract", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => { state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" + ], + "description": [ + "\nExtracts saved object references from expression AST" + ], + "label": "extract", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292" + }, + "tags": [], + "returnComment": [ + "new expression AST with references removed and array of references" + ] + }, + { + "id": "def-common.ExpressionsService.inject", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nInjects saved object references into expression AST" + ], + "label": "inject", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302" + }, + "tags": [], + "returnComment": [ + "new expression AST with references injected" + ] + }, + { + "id": "def-common.ExpressionsService.migrate", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + } + }, + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + } + } + ], + "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" + } + ], + "description": [ + "\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)" + ], + "label": "migrate", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 312, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + }, + "tags": [], + "returnComment": [ + "new migrated expression AST" + ] + }, + { + "id": "def-common.ExpressionsService.setup", + "type": "Function", + "label": "setup", + "signature": [ + "() => Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ], + "description": [ + "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 320, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L320" + } + }, + { + "id": "def-common.ExpressionsService.start", + "type": "Function", + "label": "start", + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } + ], + "description": [ + "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 328, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L328" + } + }, + { + "id": "def-common.ExpressionsService.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 332, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L332" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L174" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TablesAdapter", + "type": "Class", + "tags": [], + "label": "TablesAdapter", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TablesAdapter", + "text": "TablesAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-common.TablesAdapter.logDatatable", + "type": "Function", + "label": "logDatatable", + "signature": [ + "(name: string, datatable: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + }, + { + "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/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15" + } + }, + { + "id": "def-common.TablesAdapter.tables", + "type": "Object", + "label": "tables", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L20" + }, + "signature": [ + "{ [key: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsInspectorAdapter", + "type": "Class", + "tags": [], + "label": "ExpressionsInspectorAdapter", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsInspectorAdapter", + "text": "ExpressionsInspectorAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-common.ExpressionsInspectorAdapter.logAST", + "type": "Function", + "label": "logAST", + "signature": [ + "(ast: any) => void" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "ast", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14" + } + }, + { + "id": "def-common.ExpressionsInspectorAdapter.ast", + "type": "Any", + "label": "ast", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L19" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L11" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.isExpressionAstBuilder", + "type": "Function", + "label": "isExpressionAstBuilder", + "signature": [ + "(val: any) => boolean" + ], + "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" + ], + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "Value you want to check." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + } + } + ], + "tags": [ + "example", + "return" + ], + "returnComment": [ + "boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildExpression", + "type": "Function", + "label": "buildExpression", + "signature": [ + "(initialState: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "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" + ], + "children": [ + { + "type": "CompoundType", + "label": "initialState", + "isRequired": false, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[] | undefined" + ], + "description": [ + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildExpressionFunction", + "type": "Function", + "label": "buildExpressionFunction", + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "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" + ], + "children": [ + { + "type": "Uncategorized", + "label": "fnName", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ], + "description": [ + "String representing the name of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155" + } + }, + { + "type": "Object", + "label": "initialArgs", + "isRequired": true, + "signature": [ + "{ [K in keyof FunctionArgs]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[K] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + "[]; }" + ], + "description": [ + "Object containing the arguments to this function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163" + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152" + }, + "initialIsOpen": false + }, + { + "id": "def-common.formatExpression", + "type": "Function", + "label": "formatExpression", + "signature": [ + "(ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => string" + ], + "description": [ + "\nGiven expression pipeline AST, returns formatted string.\n" + ], + "children": [ + { + "type": "Object", + "label": "ast", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression pipeline AST." + ], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.format", + "type": "Function", + "label": "format", + "signature": [ + "(ast: T, type: T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\") => string" + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "ast", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "type", + "isRequired": true, + "signature": [ + "T extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " ? \"expression\" : \"argument\"" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.parseExpression", + "type": "Function", + "label": "parseExpression", + "signature": [ + "(expression: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "\nGiven expression pipeline string, returns parsed AST.\n" + ], + "children": [ + { + "type": "string", + "label": "expression", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Expression pipeline string." + ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.parse", + "type": "Function", + "label": "parse", + "signature": [ + "(expression: E, startRule: S) => S extends \"expression\" ? ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " : ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstArgument", + "text": "ExpressionAstArgument" + } + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "expression", + "isRequired": true, + "signature": [ + "E" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15" + } + }, + { + "type": "Uncategorized", + "label": "startRule", + "isRequired": true, + "signature": [ + "S" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(node: any) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "node", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/get_type.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/get_type.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/get_type.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/get_type.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.serializeProvider", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/serialize_provider.ts#L15" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/serialize_provider.ts#L15" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isDatatable", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "datatable", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L29" + } + } + ], + "signature": [ + "(datatable: unknown) => datatable is ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L29" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isExpressionValueError", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L25" + } + } + ], + "signature": [ + "(value: any) => value is ", + { + "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": [], + "label": "isExpressionValueError", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L25" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getBucketIdentifier", + "type": "Function", + "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" + ], + "children": [ + { + "type": "Object", + "label": "row", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15" + } + }, + { + "type": "Array", + "label": "groupColumns", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildResultColumns", + "type": "Function", + "label": "buildResultColumns", + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", outputColumnId: string, inputColumnId: string, outputColumnName: string | undefined, options: { allowColumnOverwrite: boolean; }) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[] | 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." + ], + "children": [ + { + "type": "Object", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [ + "Input datatable" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L34" + } + }, + { + "type": "string", + "label": "outputColumnId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Id of the output column" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L35" + } + }, + { + "type": "string", + "label": "inputColumnId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "Id of the input column" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L36" + } + }, + { + "type": "string", + "label": "outputColumnName", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [ + "Optional name of the output column" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L37" + } + }, + { + "id": "def-common.buildResultColumns.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.buildResultColumns.options.allowColumnOverwrite", + "type": "boolean", + "label": "allowColumnOverwrite", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L38" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-common.createExecutorContainer", + "type": "Function", + "children": [ + { + "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": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L62" + } + } + ], + "signature": [ + " = Record>(state?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" + }, + "" + ], + "description": [], + "label": "createExecutorContainer", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L59" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createExecutionContainer", + "type": "Function", + "children": [ + { + "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": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L81" + } + } + ], + "signature": [ + "(state?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" + }, + "" + ], + "description": [], + "label": "createExecutionContainer", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L80" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createError", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L21" + } + } + ], + "signature": [ + "(err: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + ") => ", + { + "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": [], + "label": "createError", + "source": { + "path": "src/plugins/expressions/common/util/create_error.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L21" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getByAlias", + "type": "Function", + "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." + ], + "children": [ + { + "type": "CompoundType", + "label": "node", + "isRequired": true, + "signature": [ + "T[] | Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L15" + } + }, + { + "type": "string", + "label": "nodeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L14" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.SerializedFieldFormat", + "type": "Interface", + "label": "SerializedFieldFormat", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SerializedFieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SerializedFieldFormat.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55" + }, + "signature": [ + "TParams | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CSSStyle", + "type": "Interface", + "label": "CSSStyle", + "description": [ + "\nRepresents the various style properties that can be applied to an element." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CSSStyle.color", + "type": "string", + "label": "color", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L91" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.fill", + "type": "string", + "label": "fill", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L92" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.fontFamily", + "type": "CompoundType", + "label": "fontFamily", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L93" + }, + "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" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.fontSize", + "type": "string", + "label": "fontSize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L94" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.fontStyle", + "type": "CompoundType", + "label": "fontStyle", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L95" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FontStyle", + "text": "FontStyle" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.fontWeight", + "type": "CompoundType", + "label": "fontWeight", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L96" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FontWeight", + "text": "FontWeight" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.lineHeight", + "type": "CompoundType", + "label": "lineHeight", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L97" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.textAlign", + "type": "CompoundType", + "label": "textAlign", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L98" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TextAlignment", + "text": "TextAlignment" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CSSStyle.textDecoration", + "type": "CompoundType", + "label": "textDecoration", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L99" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TextDecoration", + "text": "TextDecoration" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L90" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ContainerStyle", + "type": "Interface", + "label": "ContainerStyle", + "description": [ + "\nRepresents an object containing style information for a Container." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ContainerStyle.border", + "type": "CompoundType", + "label": "border", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L106" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.borderRadius", + "type": "CompoundType", + "label": "borderRadius", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L107" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.padding", + "type": "CompoundType", + "label": "padding", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L108" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.backgroundColor", + "type": "CompoundType", + "label": "backgroundColor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L109" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.backgroundImage", + "type": "CompoundType", + "label": "backgroundImage", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L110" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.backgroundSize", + "type": "Enum", + "label": "backgroundSize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L111" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.BackgroundSize", + "text": "BackgroundSize" + } + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.backgroundRepeat", + "type": "Enum", + "label": "backgroundRepeat", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L112" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.BackgroundRepeat", + "text": "BackgroundRepeat" + } + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.opacity", + "type": "CompoundType", + "label": "opacity", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L113" + }, + "signature": [ + "number | null" + ] + }, + { + "tags": [], + "id": "def-common.ContainerStyle.overflow", + "type": "Enum", + "label": "overflow", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L114" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Overflow", + "text": "Overflow" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L105" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionTypeStyle", + "type": "Interface", + "label": "ExpressionTypeStyle", + "description": [ + "\nAn object that represents style information, typically CSS." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionTypeStyle.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121" + }, + "signature": [ + "\"style\"" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeStyle.spec", + "type": "Object", + "label": "spec", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CSSStyle", + "text": "CSSStyle" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeStyle.css", + "type": "string", + "label": "css", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IRegistry", + "type": "Interface", + "label": "IRegistry", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.IRegistry.get", + "type": "Function", + "label": "get", + "signature": [ + "(id: string) => T | null" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10" + } + }, + { + "id": "def-common.IRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12" + } + }, + { + "id": "def-common.IRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => T[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstExpressionBuilder", + "type": "Interface", + "label": "ExpressionAstExpressionBuilder", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionAstExpressionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48" + }, + "signature": [ + "\"expression_builder\"" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionAstExpressionBuilder.functions", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66" + }, + "signature": [ + "(fnName: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]) => [] | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "[]" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstExpressionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts expression to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstFunctionBuilder", + "type": "Interface", + "label": "ExpressionAstFunctionBuilder", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionAstFunctionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression function builder objects." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63" + }, + "signature": [ + "\"expression_function_builder\"" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionAstFunctionBuilder.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nName of this expression function." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionAstFunctionBuilder.arguments", + "type": "Object", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74" + }, + "signature": [ + "FunctionBuilderArguments" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86" + }, + "signature": [ + ">(name: A, value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A]) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99" + }, + "signature": [ + ">(name: A) => (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[] | undefined" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111" + }, + "signature": [ + ">(name: A, value: (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]) => this" + ] + }, + { + "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" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124" + }, + "signature": [ + ">>(name: A) => this" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + } + ] + }, + { + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstFunctionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts function to an expression string.\n" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136" + }, + "signature": [ + "() => string" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Font", + "type": "Interface", + "label": "Font", + "description": [ + "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Font.label", + "type": "CompoundType", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26" + }, + "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\"" + ] + }, + { + "tags": [], + "id": "def-common.Font.value", + "type": "CompoundType", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27" + }, + "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": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionTypeDefinition", + "type": "Interface", + "label": "ExpressionTypeDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" + }, + "" + ], + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.validate", + "type": "Function", + "label": "validate", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32" + }, + "signature": [ + "((type: any) => void | Error) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.serialize", + "type": "Function", + "label": "serialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33" + }, + "signature": [ + "((type: Value) => SerializedType) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34" + }, + "signature": [ + "((type: SerializedType) => Value) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.from", + "type": "Object", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.to", + "type": "Object", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40" + }, + "signature": [ + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionTypeDefinition.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DatatableColumnMeta", + "type": "Interface", + "label": "DatatableColumnMeta", + "description": [ + "\nDatatable column meta information" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DatatableColumnMeta.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L63" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnType", + "text": "DatatableColumnType" + } + ] + }, + { + "tags": [], + "id": "def-common.DatatableColumnMeta.field", + "type": "string", + "label": "field", + "description": [ + "\nfield this column is based on" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L67" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DatatableColumnMeta.index", + "type": "string", + "label": "index", + "description": [ + "\nindex/table this column is based on" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L71" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DatatableColumnMeta.params", + "type": "Object", + "label": "params", + "description": [ + "\nserialized field format" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L75" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DatatableColumnMeta.source", + "type": "string", + "label": "source", + "description": [ + "\nsource function that produced this column" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L79" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DatatableColumnMeta.sourceParams", + "type": "Object", + "label": "sourceParams", + "description": [ + "\nany extra parameters for the source that produced this column" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L83" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DatatableColumn", + "type": "Interface", + "label": "DatatableColumn", + "description": [ + "\nThis type represents the shape of a column in a `Datatable`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DatatableColumn.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90" + } + }, + { + "tags": [], + "id": "def-common.DatatableColumn.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91" + } + }, + { + "tags": [], + "id": "def-common.DatatableColumn.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnMeta", + "text": "DatatableColumnMeta" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Datatable", + "type": "Interface", + "label": "Datatable", + "description": [ + "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Datatable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.Datatable.columns", + "type": "Array", + "label": "columns", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.Datatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101" + }, + "signature": [ + "Record[]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SerializedDatatable", + "type": "Interface", + "label": "SerializedDatatable", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SerializedDatatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105" + }, + "signature": [ + "string[][]" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionImage", + "type": "Interface", + "label": "ExpressionImage", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionImage.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15" + }, + "signature": [ + "\"image\"" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionImage.mode", + "type": "string", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.ExpressionImage.dataurl", + "type": "string", + "label": "dataurl", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PointSeriesColumn", + "type": "Interface", + "label": "PointSeriesColumn", + "description": [ + "\nColumn in a PointSeries" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PointSeriesColumn.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24" + }, + "signature": [ + "\"string\" | \"number\"" + ] + }, + { + "tags": [], + "id": "def-common.PointSeriesColumn.role", + "type": "CompoundType", + "label": "role", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25" + }, + "signature": [ + "\"measure\" | \"dimension\"" + ] + }, + { + "tags": [], + "id": "def-common.PointSeriesColumn.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Range", + "type": "Interface", + "label": "Range", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Range.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15" + }, + "signature": [ + "\"range\"" + ] + }, + { + "tags": [], + "id": "def-common.Range.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.Range.to", + "type": "number", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.Range.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionDefinition", + "type": "Interface", + "label": "ExpressionFunctionDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" + }, + " extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + ">>" + ], + "description": [ + "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.name", + "type": "Uncategorized", + "label": "name", + "description": [ + "\nThe name of the function, as will be used in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40" + }, + "signature": [ + "Name" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [ + "\nif set to true function will be disabled (but its migrate function will still be available)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.type", + "type": "CompoundType", + "label": "type", + "description": [ + "\nName of type of value this function outputs." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "<", + "UnwrapPromiseOrReturn", + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.inputTypes", + "type": "Array", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypeToString", + "text": "TypeToString" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.args", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64" + }, + "signature": [ + "{ [key in keyof Arguments]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "; }" + ] + }, + { + "tags": [ + "todo" + ], + "id": "def-common.ExpressionFunctionDefinition.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75" + } + }, + { + "id": "def-common.ExpressionFunctionDefinition.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: Input, args: Arguments, context: Context) => Output" + ], + "description": [ + "\nThe actual implementation of the function.\n" + ], + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "Input" + ], + "description": [ + "Output of the previous function, or initial input." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [ + "Parameters set for this function in expression." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "type": "Uncategorized", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86" + } + }, + { + "tags": [ + "deprecated" + ], + "id": "def-common.ExpressionFunctionDefinition.context", + "type": "Object", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91" + }, + "signature": [ + "{ types: any[] | undefined; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionDefinitions", + "type": "Interface", + "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" + ], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.clog", + "type": "Object", + "label": "clog", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.font", + "type": "Object", + "label": "font", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.var_set", + "type": "Object", + "label": "var_set", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.var", + "type": "Object", + "label": "var", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.theme", + "type": "Object", + "label": "theme", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.cumulative_sum", + "type": "Object", + "label": "cumulative_sum", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.derivative", + "type": "Object", + "label": "derivative", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionDefinitions.moving_average", + "type": "Object", + "label": "moving_average", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MapColumnArguments", + "type": "Interface", + "label": "MapColumnArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MapColumnArguments.id", + "type": "CompoundType", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L14" + }, + "signature": [ + "string | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.MapColumnArguments.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L15" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L16" + }, + "signature": [ + "((datatable: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.MapColumnArguments.copyMetaFrom", + "type": "CompoundType", + "label": "copyMetaFrom", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L17" + }, + "signature": [ + "string | null | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CumulativeSumArgs", + "type": "Interface", + "label": "CumulativeSumArgs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CumulativeSumArgs.by", + "type": "Array", + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L15" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CumulativeSumArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.CumulativeSumArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.CumulativeSumArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L18" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DerivativeArgs", + "type": "Interface", + "label": "DerivativeArgs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DerivativeArgs.by", + "type": "Array", + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L15" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DerivativeArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.DerivativeArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.DerivativeArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L18" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MovingAverageArgs", + "type": "Interface", + "label": "MovingAverageArgs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MovingAverageArgs.by", + "type": "Array", + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L15" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.window", + "type": "number", + "label": "window", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L19" + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionRenderDefinition", + "type": "Interface", + "label": "ExpressionRenderDefinition", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.name", + "type": "string", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.displayName", + "type": "string", + "label": "displayName", + "description": [ + "\nA user friendly name of the renderer as will be displayed to user in UI." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.help", + "type": "string", + "label": "help", + "description": [ + "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nUsed to validate the data before calling the render function." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31" + }, + "signature": [ + "(() => Error | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", + "description": [ + "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.ExpressionRenderDefinition.render", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42" + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" + }, + ") => void | Promise" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IInterpreterRenderHandlers", + "type": "Interface", + "label": "IInterpreterRenderHandlers", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.done", + "type": "Function", + "label": "done", + "description": [ + "\nDone increments the number of rendering successes" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.onDestroy", + "type": "Function", + "label": "onDestroy", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68" + }, + "signature": [ + "(fn: () => void) => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.reload", + "type": "Function", + "label": "reload", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70" + }, + "signature": [ + "(params: any) => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.event", + "type": "Function", + "label": "event", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71" + }, + "signature": [ + "(event: any) => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72" + }, + "signature": [ + "((event: any) => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.getRenderMode", + "type": "Function", + "label": "getRenderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.RenderMode", + "text": "RenderMode" + } + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74" + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.uiState", + "type": "Unknown", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutorState", + "type": "Interface", + "label": "ExecutorState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutorState.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorState.types", + "type": "Object", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorState.context", + "type": "Uncategorized", + "label": "context", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19" + }, + "signature": [ + "Context" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutorPureTransitions", + "type": "Interface", + "label": "ExecutorPureTransitions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutorPureTransitions.addFunction", + "type": "Function", + "label": "addFunction", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L29" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (fn: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorPureTransitions.addType", + "type": "Function", + "label": "addType", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L30" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (type: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorPureTransitions.extendContext", + "type": "Function", + "label": "extendContext", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L31" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (extraContext: Record) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutorPureSelectors", + "type": "Interface", + "label": "ExecutorPureSelectors", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutorPureSelectors.getFunction", + "type": "Function", + "label": "getFunction", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L44" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorPureSelectors.getType", + "type": "Function", + "label": "getType", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L45" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-common.ExecutorPureSelectors.getContext", + "type": "Function", + "label": "getContext", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L46" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => () => Record" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionExecOptions", + "type": "Interface", + "label": "ExpressionExecOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionExecOptions.debug", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L33" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionContext", + "type": "Interface", + "label": "ExecutionContext", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ], + "description": [ + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutionContext.getSearchContext", + "type": "Function", + "label": "getSearchContext", + "description": [ + "\nGet search context of the expression." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28" + }, + "signature": [ + "() => ExecutionContextSearch" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.variables", + "type": "Object", + "label": "variables", + "description": [ + "\nContext variables that can be consumed using `var` and `var_set` functions." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.types", + "type": "Object", + "label": "types", + "description": [ + "\nA map of available expression types." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAdds ability to abort current execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43" + }, + "signature": [ + "AbortSignal" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "description": [ + "\nAdapters for `inspector` plugin." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48" + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.getSearchSessionId", + "type": "Function", + "label": "getSearchSessionId", + "description": [ + "\nSearch context in which expression should operate." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53" + }, + "signature": [ + "() => string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.getKibanaRequest", + "type": "Function", + "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": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60" + }, + "signature": [ + "(() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.getSavedObject", + "type": "Function", + "label": "getSavedObject", + "description": [ + "\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71" + }, + "signature": [ + "((type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionContext.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync colors across panels switch." + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79" + }, + "signature": [ + "(() => boolean) | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DefaultInspectorAdapters", + "type": "Interface", + "label": "DefaultInspectorAdapters", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DefaultInspectorAdapters", + "text": "DefaultInspectorAdapters" + }, + " extends ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "description": [ + "\nDefault inspector adapters created if inspector adapters are not set explicitly." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DefaultInspectorAdapters.requests", + "type": "Object", + "label": "requests", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L86" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + } + ] + }, + { + "tags": [], + "id": "def-common.DefaultInspectorAdapters.tables", + "type": "Object", + "label": "tables", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L87" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TablesAdapter", + "text": "TablesAdapter" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L85" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionState", + "type": "Interface", + "label": "ExecutionState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutionState.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [], + "id": "def-common.ExecutionState.state", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28" + }, + "signature": [ + "\"result\" | \"error\" | \"not-started\" | \"pending\"" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionState.result", + "type": "Uncategorized", + "label": "result", + "description": [ + "\nResult of the expression execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33" + }, + "signature": [ + "Output | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionState.error", + "type": "Object", + "label": "error", + "description": [ + "\nError happened during the execution." + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38" + }, + "signature": [ + "Error | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionPureTransitions", + "type": "Interface", + "label": "ExecutionPureTransitions", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutionPureTransitions.start", + "type": "Function", + "label": "start", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L51" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => () => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionPureTransitions.setResult", + "type": "Function", + "label": "setResult", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L52" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => (result: Output) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionPureTransitions.setError", + "type": "Function", + "label": "setError", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L53" + }, + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => (error: Error) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L50" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionParams", + "type": "Interface", + "label": "ExecutionParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExecutionParams.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionParams.ast", + "type": "Object", + "label": "ast", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionParams.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExecutionParams.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionExecutionParams", + "type": "Interface", + "label": "ExpressionExecutionParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.searchContext", + "type": "Object", + "label": "searchContext", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L42" + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.variables", + "type": "Object", + "label": "variables", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L44" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.debug", + "type": "CompoundType", + "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." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L51" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.kibanaRequest", + "type": "Object", + "label": "kibanaRequest", + "description": [ + "\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L58" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.searchSessionId", + "type": "string", + "label": "searchSessionId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.syncColors", + "type": "CompoundType", + "label": "syncColors", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L62" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionExecutionParams.inspectorAdapters", + "type": "Object", + "label": "inspectorAdapters", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L64" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L41" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsServiceStart", + "type": "Interface", + "label": "ExpressionsServiceStart", + "description": [ + "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.getFunction", + "type": "Function", + "label": "getFunction", + "description": [ + "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L78" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.getRenderer", + "type": "Function", + "label": "getRenderer", + "description": [ + "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L86" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.getType", + "type": "Function", + "label": "getType", + "description": [ + "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L94" + }, + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.run", + "type": "Function", + "label": "run", + "description": [ + "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L120" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => Promise" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.execute", + "type": "Function", + "label": "execute", + "description": [ + "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L131" + }, + "signature": [ + "(ast: string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + " | undefined) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.fork", + "type": "Function", + "label": "fork", + "description": [ + "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L147" + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L71" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionServiceParams", + "type": "Interface", + "label": "ExpressionServiceParams", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionServiceParams.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L151" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionServiceParams.renderers", + "type": "Object", + "label": "renderers", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L152" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L150" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.BackgroundRepeat", + "type": "Enum", + "label": "BackgroundRepeat", + "tags": [], + "description": [ + "\nEnum of supported CSS `background-repeat` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BackgroundSize", + "type": "Enum", + "label": "BackgroundSize", + "tags": [], + "description": [ + "\nEnum of supported CSS `background-size` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FontStyle", + "type": "Enum", + "label": "FontStyle", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-style` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FontWeight", + "type": "Enum", + "label": "FontWeight", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-weight` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Overflow", + "type": "Enum", + "label": "Overflow", + "tags": [], + "description": [ + "\nEnum of supported CSS `overflow` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TextAlignment", + "type": "Enum", + "label": "TextAlignment", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-align` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TextDecoration", + "type": "Enum", + "label": "TextDecoration", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-decoration` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-common.TypeToString", + "type": "Type", + "label": "TypeToString", + "tags": [], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17" + }, + "signature": [ + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-common.KnownTypeToString", + "type": "Type", + "label": "KnownTypeToString", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26" + }, + "signature": [ + "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" + ], + "initialIsOpen": false + }, + { + "id": "def-common.TypeString", + "type": "Type", + "label": "TypeString", + "tags": [], + "description": [ + "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39" + }, + "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" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UnmappedTypeStrings", + "type": "Type", + "label": "UnmappedTypeStrings", + "tags": [], + "description": [ + "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" + ], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46" + }, + "signature": [ + "\"date\" | \"filter\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Style", + "type": "Type", + "label": "Style", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126" + }, + "signature": [ + "ExpressionTypeStyle" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InferFunctionDefinition", + "type": "Type", + "label": "InferFunctionDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L24" + }, + "signature": [ + "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstNode", + "type": "Type", + "label": "ExpressionAstNode", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstExpression", + "type": "Type", + "label": "ExpressionAstExpression", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16" + }, + "signature": [ + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstFunction", + "type": "Type", + "label": "ExpressionAstFunction", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21" + }, + "signature": [ + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstFunctionDebug", + "type": "Type", + "label": "ExpressionAstFunctionDebug", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L32" + }, + "signature": [ + "{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ", + { + "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; }> | undefined; rawError?: any | Error; duration: number | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstArgument", + "type": "Type", + "label": "ExpressionAstArgument", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77" + }, + "signature": [ + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.FontLabel", + "type": "Type", + "label": "FontLabel", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FontValue", + "type": "Type", + "label": "FontValue", + "tags": [], + "description": [ + "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + }, + "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\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.fonts", + "type": "Array", + "label": "fonts", + "description": [ + "\nA collection of supported fonts." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L123" + }, + "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\"; })[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueUnboxed", + "type": "Type", + "label": "ExpressionValueUnboxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueBoxed", + "type": "Type", + "label": "ExpressionValueBoxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11" + }, + "signature": [ + "{ type: Type; } & Value" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValue", + "type": "Type", + "label": "ExpressionValue", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueConverter", + "type": "Type", + "label": "ExpressionValueConverter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17" + }, + "signature": [ + "(input: I, availableTypes: Record) => O" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AnyExpressionTypeDefinition", + "type": "Type", + "label": "AnyExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46" + }, + "signature": [ + "ExpressionTypeDefinition" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.typeSpecs", + "type": "Array", + "label": "typeSpecs", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/index.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/index.ts#L25" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DatatableColumnType", + "type": "Type", + "label": "DatatableColumnType", + "tags": [], + "description": [ + "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36" + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DatatableRow", + "type": "Type", + "label": "DatatableRow", + "tags": [], + "description": [ + "\nThis type represents a row in a `Datatable`." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueError", + "type": "Type", + "label": "ExpressionValueError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InterpreterErrorType", + "type": "Type", + "label": "InterpreterErrorType", + "tags": [ + "deprecated" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33" + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14" + }, + "signature": [ + "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueNum", + "type": "Type", + "label": "ExpressionValueNum", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14" + }, + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PointSeriesColumnName", + "type": "Type", + "label": "PointSeriesColumnName", + "tags": [], + "description": [ + "\nAllowed column names in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18" + }, + "signature": [ + "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PointSeriesColumns", + "type": "Type", + "label": "PointSeriesColumns", + "tags": [], + "description": [ + "\nRepresents a collection of valid Columns in a PointSeries" + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32" + }, + "signature": [ + "{} | Record<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumnName", + "text": "PointSeriesColumnName" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.PointSeriesColumn", + "text": "PointSeriesColumn" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PointSeriesRow", + "type": "Type", + "label": "PointSeriesRow", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34" + }, + "signature": [ + "{ [x: string]: any; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PointSeries", + "type": "Type", + "label": "PointSeries", + "tags": [], + "description": [ + "\nA `PointSeries` is a unique structure that represents dots on a chart." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39" + }, + "signature": [ + "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Render", + "type": "Type", + "label": "Render", + "tags": [ + "deprecated" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L29" + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AnyExpressionFunctionDefinition", + "type": "Type", + "label": "AnyExpressionFunctionDefinition", + "tags": [], + "description": [ + "\nType to capture every possible expression function definition." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102" + }, + "signature": [ + "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ArgumentType", + "type": "Type", + "label": "ArgumentType", + "tags": [], + "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." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/arguments.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16" + }, + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.functionSpecs", + "type": "Array", + "label": "functionSpecs", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/index.ts#L21" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + "[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.MathArguments", + "type": "Type", + "label": "MathArguments", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L15" + }, + "signature": [ + "{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.MathInput", + "type": "Type", + "label": "MathInput", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L20" + }, + "signature": [ + "number | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionClog", + "type": "Type", + "label": "ExpressionFunctionClog", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L11" + }, + "signature": [ + "ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionFont", + "type": "Type", + "label": "ExpressionFunctionFont", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L44" + }, + "signature": [ + "ExpressionFunctionDefinition<\"font\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeStyle", + "text": "ExpressionTypeStyle" + }, + ", ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionVarSet", + "type": "Type", + "label": "ExpressionFunctionVarSet", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L17" + }, + "signature": [ + "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionVar", + "type": "Type", + "label": "ExpressionFunctionVar", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L16" + }, + "signature": [ + "ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionTheme", + "type": "Type", + "label": "ExpressionFunctionTheme", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L20" + }, + "signature": [ + "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionCumulativeSum", + "type": "Type", + "label": "ExpressionFunctionCumulativeSum", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L21" + }, + "signature": [ + "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionDerivative", + "type": "Type", + "label": "ExpressionFunctionDerivative", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L21" + }, + "signature": [ + "ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionMovingAverage", + "type": "Type", + "label": "ExpressionFunctionMovingAverage", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L22" + }, + "signature": [ + "ExpressionFunctionDefinition<\"moving_average\", Datatable, MovingAverageArgs, Datatable, ", + { + "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", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AnyExpressionRenderDefinition", + "type": "Type", + "label": "AnyExpressionRenderDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L49" + }, + "signature": [ + "ExpressionRenderDefinition" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RenderMode", + "type": "Type", + "label": "RenderMode", + "tags": [], + "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" + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L61" + }, + "signature": [ + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExecutorContainer", + "type": "Type", + "label": "ExecutorContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55" + }, + "signature": [ + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExecutionContainer", + "type": "Type", + "label": "ExecutionContainer", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73" + }, + "signature": [ + "StateContainer, ExecutionPureTransitions, {}>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsServiceSetup", + "type": "Type", + "label": "ExpressionsServiceSetup", + "tags": [], + "description": [ + "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L26" + }, + "signature": [ + "{ readonly getType: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined; readonly getFunction: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null; readonly getRenderers: () => Record false" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L18" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.boolean.from.number", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "n", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L19" + } + } + ], + "signature": [ + "(n: any) => boolean" + ], + "description": [], + "label": "number", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L19" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.boolean.from.string", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "s", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L20" + } + } + ], + "signature": [ + "(s: any) => boolean" + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L20" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L17" + } + }, + { + "id": "def-common.boolean.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.boolean.to.render", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "value", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L23" + } + } + ], + "signature": [ + "(value: boolean) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: string; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L23" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.boolean.to.datatable", + "type": "Function", + "children": [ + { + "type": "boolean", + "label": "value", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L31" + } + } + ], + "signature": [ + "(value: boolean) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L31" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L22" + } + } + ], + "description": [], + "label": "boolean", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.datatable", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.datatable.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L116" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "id": "def-common.datatable.validate", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "table", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L117" + } + } + ], + "signature": [ + "(table: any) => void" + ], + "description": [], + "label": "validate", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L117" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.datatable.serialize", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L127" + } + } + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => { rows: any[][]; type: \"datatable\"; columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]; }" + ], + "description": [], + "label": "serialize", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L127" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.datatable.deserialize", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "table", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L136" + } + } + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" + }, + ") => { rows: _.Dictionary[]; type: \"datatable\"; columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]; }" + ], + "description": [], + "label": "deserialize", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L136" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.datatable.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.datatable.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L146" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.datatable.from.pointseries", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "value", + "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/datatable.ts", + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L152" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L152" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L145" + } + }, + { + "id": "def-common.datatable.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.datatable.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L162" + } + } + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: RenderedDatatable; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L162" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.datatable.to.pointseries", + "type": "Function", + "children": [ + { + "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": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L172" + } + } + ], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => ", + { + "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": [], + "label": "pointseries", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L172" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L161" + } + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L115" + }, + "initialIsOpen": false + }, + { + "id": "def-common.error", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.error.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L36" + }, + "signature": [ + "\"error\"" + ] + }, + { + "id": "def-common.error.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.error.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L38" + } + } + ], + "signature": [ + "(input: ", + { + "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; }>) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + } + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L38" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L37" + } + } + ], + "description": [], + "label": "error", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.filter", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.filter.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L28" + }, + "signature": [ + "\"filter\"" + ] + }, + { + "id": "def-common.filter.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.filter.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: \"filter\"; filterType: string; meta: {}; and: never[]; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L30" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L29" + } + } + ], + "description": [], + "label": "filter", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.image", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.image.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L21" + }, + "signature": [ + "\"image\"" + ] + }, + { + "id": "def-common.image.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.image.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L23" + } + } + ], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: Pick<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + }, + ", \"dataurl\" | \"mode\">; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L23" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L22" + } + } + ], + "description": [], + "label": "image", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.nullType", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.nullType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L14" + }, + "signature": [ + "\"null\"" + ] + }, + { + "id": "def-common.nullType.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.nullType.from.'*'", + "type": "Function", + "children": [], + "signature": [ + "() => null" + ], + "description": [], + "label": "'*'", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L16" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L15" + } + } + ], + "description": [], + "label": "nullType", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.num", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.num.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L22" + }, + "signature": [ + "\"num\"" + ] + }, + { + "id": "def-common.num.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.num.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: \"num\"; value: number; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L24" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.from.boolean", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "b", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L28" + } + } + ], + "signature": [ + "(b: any) => { type: \"num\"; value: number; }" + ], + "description": [], + "label": "boolean", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L28" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.from.string", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "n", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L32" + } + } + ], + "signature": [ + "(n: any) => { type: \"num\"; value: number; }" + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L32" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.from.'*'", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L49" + } + } + ], + "signature": [ + "(value: any) => { type: \"num\"; value: number; }" + ], + "description": [], + "label": "'*'", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L49" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L23" + } + }, + { + "id": "def-common.num.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.num.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L55" + } + } + ], + "signature": [ + "({ value }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"num\", { value: number; }>) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: string; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L55" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.to.datatable", + "type": "Function", + "children": [ + { + "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": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L63" + } + } + ], + "signature": [ + "({ value }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"num\", { value: number; }>) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L63" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L54" + } + } + ], + "description": [], + "label": "num", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.number", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.number.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L17" + }, + "signature": [ + "\"number\"" + ] + }, + { + "id": "def-common.number.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.number.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => number" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L19" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.number.from.boolean", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "b", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L20" + } + } + ], + "signature": [ + "(b: any) => number" + ], + "description": [], + "label": "boolean", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L20" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.number.from.string", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "n", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L21" + } + } + ], + "signature": [ + "(n: any) => number" + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L21" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L18" + } + }, + { + "id": "def-common.number.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.number.to.render", + "type": "Function", + "children": [ + { + "type": "number", + "label": "value", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L37" + } + } + ], + "signature": [ + "(value: number) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: string; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L37" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.number.to.datatable", + "type": "Function", + "children": [ + { + "type": "number", + "label": "value", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L45" + } + } + ], + "signature": [ + "(value: number) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L45" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L36" + } + } + ], + "description": [], + "label": "number", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.pointseries", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.pointseries.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L48" + }, + "signature": [ + "\"pointseries\"" + ] + }, + { + "id": "def-common.pointseries.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.pointseries.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: \"pointseries\"; rows: never[]; columns: {}; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L50" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L49" + } + }, + { + "id": "def-common.pointseries.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.pointseries.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L60" + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L61" + } + } + ], + "signature": [ + "(pseries: ", + { + "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[]; }>, types: Record) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { datatable: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; showHeader: boolean; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L59" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L58" + } + } + ], + "description": [], + "label": "pointseries", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-common.range", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.range.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L22" + }, + "signature": [ + "\"range\"" + ] + }, + { + "id": "def-common.range.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.range.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Range", + "text": "Range" + } + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L24" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L23" + } + }, + { + "id": "def-common.range.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.range.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L33" + } + } + ], + "signature": [ + "(value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Range", + "text": "Range" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: string; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L33" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L32" + } + } + ], + "description": [], + "label": "range", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.render", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.render.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L32" + }, + "signature": [ + "\"render\"" + ] + }, + { + "id": "def-common.render.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.render.from.'*'", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "v", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L34" + } + } + ], + "signature": [ + "(v: T) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: T; }>" + ], + "description": [], + "label": "'*'", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L34" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L33" + } + } + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.shape", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.shape.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L15" + }, + "signature": [ + "\"shape\"" + ] + }, + { + "id": "def-common.shape.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.shape.to.render", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L17" + } + } + ], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: any; }>) => { type: string; as: string; value: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: any; }>; }" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L17" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L16" + } + } + ], + "description": [], + "label": "shape", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.string", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.string.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L16" + }, + "signature": [ + "\"string\"" + ] + }, + { + "id": "def-common.string.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.string.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L18" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.string.from.boolean", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "b", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L19" + } + } + ], + "signature": [ + "(b: any) => string" + ], + "description": [], + "label": "boolean", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L19" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.string.from.number", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "n", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L20" + } + } + ], + "signature": [ + "(n: any) => string" + ], + "description": [], + "label": "number", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L20" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L17" + } + }, + { + "id": "def-common.string.to", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.string.to.render", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "text", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L23" + } + } + ], + "signature": [ + "(text: T) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: T; }; }>" + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L23" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.string.to.datatable", + "type": "Function", + "children": [ + { + "type": "string", + "label": "value", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L30" + } + } + ], + "signature": [ + "(value: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L30" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L22" + } + } + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.style", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.style.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L15" + }, + "signature": [ + "\"style\"" + ] + }, + { + "id": "def-common.style.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.style.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => { type: \"style\"; spec: {}; css: string; }" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L17" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L16" + } + } + ], + "description": [], + "label": "style", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.mapColumn", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.mapColumn.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L26" + }, + "signature": [ + "\"mapColumn\"" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L27" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L28" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L29" + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L30" + } + }, + { + "id": "def-common.mapColumn.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.mapColumn.args.id", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.mapColumn.args.id.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L42" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.id.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L43" + } + }, + { + "tags": [], + "id": "def-common.mapColumn.args.id.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L47" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.id.default", + "type": "Uncategorized", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L48" + }, + "signature": [ + "null" + ] + } + ], + "description": [], + "label": "id", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L41" + } + }, + { + "id": "def-common.mapColumn.args.name", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.mapColumn.args.name.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L51" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.name.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L52" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.name.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L53" + } + }, + { + "tags": [], + "id": "def-common.mapColumn.args.name.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L56" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "name", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L50" + } + }, + { + "id": "def-common.mapColumn.args.expression", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.mapColumn.args.expression.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L59" + }, + "signature": [ + "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.expression.resolve", + "type": "boolean", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L60" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.expression.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L61" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.expression.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L62" + } + }, + { + "tags": [], + "id": "def-common.mapColumn.args.expression.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L69" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "expression", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L58" + } + }, + { + "id": "def-common.mapColumn.args.copyMetaFrom", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.mapColumn.args.copyMetaFrom.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L72" + }, + "signature": [ + "(\"string\" | \"null\")[]" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.copyMetaFrom.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L73" + } + }, + { + "tags": [], + "id": "def-common.mapColumn.args.copyMetaFrom.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L77" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.mapColumn.args.copyMetaFrom.default", + "type": "Uncategorized", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L78" + }, + "signature": [ + "null" + ] + } + ], + "description": [], + "label": "copyMetaFrom", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L71" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L40" + } + }, + { + "id": "def-common.mapColumn.fn", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "input", + "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": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MapColumnArguments", + "text": "MapColumnArguments" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81" + } + } + ], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", args: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MapColumnArguments", + "text": "MapColumnArguments" + }, + ") => Promise<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ">" + ], + "description": [], + "label": "fn", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "mapColumn", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.math", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.math.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L85" + }, + "signature": [ + "\"math\"" + ] + }, + { + "tags": [], + "id": "def-common.math.type", + "type": "Uncategorized", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L86" + }, + "signature": [ + "undefined" + ] + }, + { + "tags": [], + "id": "def-common.math.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L87" + }, + "signature": [ + "(\"number\" | \"datatable\")[]" + ] + }, + { + "tags": [], + "id": "def-common.math.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L88" + } + }, + { + "id": "def-common.math.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.math.args.expression", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.math.args.expression.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L103" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.math.args.expression.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L104" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.math.args.expression.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L105" + } + } + ], + "description": [], + "label": "expression", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L102" + } + }, + { + "id": "def-common.math.args.onError", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.math.args.onError.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L114" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.math.args.onError.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L115" + }, + "signature": [ + "(\"null\" | \"false\" | \"zero\" | \"throw\")[]" + ] + }, + { + "tags": [], + "id": "def-common.math.args.onError.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L116" + } + } + ], + "description": [], + "label": "onError", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L113" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L101" + } + }, + { + "id": "def-common.math.fn", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "input", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MathInput", + "text": "MathInput" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MathArguments", + "text": "MathArguments" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "math", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L79" + }, + "initialIsOpen": false + }, + { + "id": "def-common.clog", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.clog.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L14" + }, + "signature": [ + "\"clog\"" + ] + }, + { + "id": "def-common.clog.args", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.clog.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L16" + } + }, + { + "id": "def-common.clog.fn", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L17" + } + } + ], + "signature": [ + "(input: unknown) => unknown" + ], + "description": [], + "label": "fn", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L17" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "clog", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.font", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L47" + }, + "signature": [ + "\"font\"" + ] + }, + { + "tags": [], + "id": "def-common.font.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L48" + }, + "signature": [ + "never[]" + ] + }, + { + "tags": [], + "id": "def-common.font.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L49" + }, + "signature": [ + "\"style\"" + ] + }, + { + "tags": [], + "id": "def-common.font.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L50" + } + }, + { + "tags": [], + "id": "def-common.font.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L53" + }, + "signature": [ + "\"null\"[]" + ] + }, + { + "id": "def-common.font.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.font.args.align", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.align.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.font.args.align.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.font.args.align.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L60" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TextAlignment", + "text": "TextAlignment" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.align.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L61" + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "align", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L55" + } + }, + { + "id": "def-common.font.args.color", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.color.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L64" + } + }, + { + "tags": [], + "id": "def-common.font.args.color.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L65" + } + }, + { + "tags": [], + "id": "def-common.font.args.color.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L68" + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "color", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L63" + } + }, + { + "id": "def-common.font.args.family", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.family.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L71" + } + }, + { + "tags": [], + "id": "def-common.font.args.family.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L72" + } + }, + { + "tags": [], + "id": "def-common.font.args.family.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L78" + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "family", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L70" + } + }, + { + "id": "def-common.font.args.italic", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.italic.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L81" + } + }, + { + "tags": [], + "id": "def-common.font.args.italic.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L82" + } + }, + { + "tags": [], + "id": "def-common.font.args.italic.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L85" + }, + "signature": [ + "boolean[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.italic.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L86" + }, + "signature": [ + "\"boolean\"[]" + ] + } + ], + "description": [], + "label": "italic", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L80" + } + }, + { + "id": "def-common.font.args.lHeight", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.lHeight.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L89" + } + }, + { + "tags": [], + "id": "def-common.font.args.lHeight.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L90" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.lHeight.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L91" + } + }, + { + "tags": [], + "id": "def-common.font.args.lHeight.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L94" + }, + "signature": [ + "(\"number\" | \"null\")[]" + ] + } + ], + "description": [], + "label": "lHeight", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L88" + } + }, + { + "id": "def-common.font.args.size", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.size.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L97" + } + }, + { + "tags": [], + "id": "def-common.font.args.size.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L98" + } + }, + { + "tags": [], + "id": "def-common.font.args.size.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L101" + }, + "signature": [ + "\"number\"[]" + ] + } + ], + "description": [], + "label": "size", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L96" + } + }, + { + "id": "def-common.font.args.underline", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.underline.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L104" + } + }, + { + "tags": [], + "id": "def-common.font.args.underline.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L105" + } + }, + { + "tags": [], + "id": "def-common.font.args.underline.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L108" + }, + "signature": [ + "boolean[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.underline.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L109" + }, + "signature": [ + "\"boolean\"[]" + ] + } + ], + "description": [], + "label": "underline", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L103" + } + }, + { + "id": "def-common.font.args.weight", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.font.args.weight.default", + "type": "string", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L112" + } + }, + { + "tags": [], + "id": "def-common.font.args.weight.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L113" + } + }, + { + "tags": [], + "id": "def-common.font.args.weight.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L123" + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FontWeight", + "text": "FontWeight" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.weight.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L124" + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "weight", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L111" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L54" + } + }, + { + "id": "def-common.font.fn", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "null" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "font", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-common.variableSet", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variableSet.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L25" + }, + "signature": [ + "\"var_set\"" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L26" + } + }, + { + "id": "def-common.variableSet.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.variableSet.args.name", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variableSet.args.name.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L31" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.args.name.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L32" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.args.name.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L33" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.args.name.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L34" + } + } + ], + "description": [], + "label": "name", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L30" + } + }, + { + "id": "def-common.variableSet.args.value", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variableSet.args.value.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L39" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.args.value.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L40" + } + } + ], + "description": [], + "label": "value", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L38" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L29" + } + }, + { + "id": "def-common.variableSet.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: unknown, args: Arguments, context: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">) => unknown" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46" + } + }, + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46" + } + } + ], + "description": [], + "label": "variableSet", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.variable", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variable.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L24" + }, + "signature": [ + "\"var\"" + ] + }, + { + "tags": [], + "id": "def-common.variable.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L25" + } + }, + { + "id": "def-common.variable.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.variable.args.name", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variable.args.name.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L30" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.variable.args.name.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L31" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.variable.args.name.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L32" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.variable.args.name.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L33" + } + } + ], + "description": [], + "label": "name", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L29" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L28" + } + }, + { + "id": "def-common.variable.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: unknown, args: Arguments, context: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">) => any" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38" + } + }, + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38" + } + } + ], + "description": [], + "label": "variable", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.theme", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.theme.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L28" + }, + "signature": [ + "\"theme\"" + ] + }, + { + "tags": [], + "id": "def-common.theme.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L29" + }, + "signature": [ + "never[]" + ] + }, + { + "tags": [], + "id": "def-common.theme.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.theme.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L33" + }, + "signature": [ + "\"null\"[]" + ] + }, + { + "id": "def-common.theme.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.theme.args.variable", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.theme.args.variable.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L36" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.theme.args.variable.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.theme.args.variable.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L40" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.theme.args.variable.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L41" + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "variable", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L35" + } + }, + { + "id": "def-common.theme.args.default", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.theme.args.default.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L44" + } + } + ], + "description": [], + "label": "default", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L43" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L34" + } + }, + { + "id": "def-common.theme.fn", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "null" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49" + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Arguments" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49" + } + }, + { + "type": "Object", + "label": "handlers", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49" + } + } + ], + "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" + }, + ", ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">) => any" + ], + "description": [], + "label": "fn", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "theme", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.cumulativeSum", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.cumulativeSum.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L56" + }, + "signature": [ + "\"cumulative_sum\"" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L57" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L59" + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L61" + } + }, + { + "id": "def-common.cumulativeSum.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.cumulativeSum.args.by", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.cumulativeSum.args.by.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L67" + } + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.by.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L70" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.by.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L71" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.by.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L72" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "by", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L66" + } + }, + { + "id": "def-common.cumulativeSum.args.inputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.cumulativeSum.args.inputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L75" + } + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.inputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L78" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.inputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L79" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "inputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L74" + } + }, + { + "id": "def-common.cumulativeSum.args.outputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L82" + } + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L85" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L86" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "outputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L81" + } + }, + { + "id": "def-common.cumulativeSum.args.outputColumnName", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnName.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L89" + } + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnName.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L92" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnName.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L93" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "outputColumnName", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L88" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L65" + } + }, + { + "id": "def-common.cumulativeSum.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { by, inputColumnId, outputColumnId, outputColumnName }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "input", + "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/cumulative_sum.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97" + } + }, + { + "type": "Object", + "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-common.derivative", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.derivative.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L57" + }, + "signature": [ + "\"derivative\"" + ] + }, + { + "tags": [], + "id": "def-common.derivative.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L58" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.derivative.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L60" + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L62" + } + }, + { + "id": "def-common.derivative.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.derivative.args.by", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.derivative.args.by.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L68" + } + }, + { + "tags": [], + "id": "def-common.derivative.args.by.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L71" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.by.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L72" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.by.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L73" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "by", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L67" + } + }, + { + "id": "def-common.derivative.args.inputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.derivative.args.inputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L76" + } + }, + { + "tags": [], + "id": "def-common.derivative.args.inputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L79" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.inputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L80" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "inputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L75" + } + }, + { + "id": "def-common.derivative.args.outputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.derivative.args.outputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L83" + } + }, + { + "tags": [], + "id": "def-common.derivative.args.outputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L86" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.outputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L87" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "outputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L82" + } + }, + { + "id": "def-common.derivative.args.outputColumnName", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.derivative.args.outputColumnName.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L90" + } + }, + { + "tags": [], + "id": "def-common.derivative.args.outputColumnName.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L93" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.outputColumnName.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L94" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "outputColumnName", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L89" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L66" + } + }, + { + "id": "def-common.derivative.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { by, inputColumnId, outputColumnId, outputColumnName }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "input", + "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/derivative.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98" + } + }, + { + "type": "Object", + "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-common.movingAverage", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L55" + }, + "signature": [ + "\"moving_average\"" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L56" + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L58" + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L60" + } + }, + { + "id": "def-common.movingAverage.args", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.movingAverage.args.by", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.args.by.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L66" + } + }, + { + "tags": [], + "id": "def-common.movingAverage.args.by.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L69" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.by.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L70" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.by.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L71" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "by", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L65" + } + }, + { + "id": "def-common.movingAverage.args.inputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.args.inputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L74" + } + }, + { + "tags": [], + "id": "def-common.movingAverage.args.inputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L77" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.inputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L78" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "inputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L73" + } + }, + { + "id": "def-common.movingAverage.args.outputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnId.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L81" + } + }, + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnId.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L84" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnId.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L85" + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "outputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L80" + } + }, + { + "id": "def-common.movingAverage.args.outputColumnName", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnName.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L88" + } + }, + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnName.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L91" + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.outputColumnName.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L92" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "outputColumnName", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L87" + } + }, + { + "id": "def-common.movingAverage.args.window", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.movingAverage.args.window.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L95" + } + }, + { + "tags": [], + "id": "def-common.movingAverage.args.window.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L98" + }, + "signature": [ + "\"number\"[]" + ] + }, + { + "tags": [], + "id": "def-common.movingAverage.args.window.default", + "type": "number", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L99" + } + } + ], + "description": [], + "label": "window", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L94" + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L64" + } + }, + { + "id": "def-common.movingAverage.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { by, inputColumnId, outputColumnId, outputColumnName, window }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "input", + "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/moving_average.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103" + } + }, + { + "type": "Object", + "label": "{ by, inputColumnId, outputColumnId, outputColumnName, window }", + "isRequired": true, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.MovingAverageArgs", + "text": "MovingAverageArgs" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-common.defaultState", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.defaultState.functions", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "functions", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L23" + } + }, + { + "id": "def-common.defaultState.types", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "types", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L24" + } + }, + { + "id": "def-common.defaultState.context", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "context", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L25" + } + } + ], + "description": [], + "label": "defaultState", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.pureTransitions", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.pureTransitions.addFunction", + "type": "Function", + "children": [ + { + "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": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L35" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (fn: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ") => { functions: { [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + "; }; types: Record; context: Record; }" + ], + "description": [], + "label": "addFunction", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L35" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureTransitions.addType", + "type": "Function", + "children": [ + { + "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": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L36" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (type: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ") => { types: { [x: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + "; }; functions: Record; context: Record; }" + ], + "description": [], + "label": "addType", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L36" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureTransitions.extendContext", + "type": "Function", + "children": [ + { + "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": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L37" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (extraContext: Record) => { context: { [x: string]: unknown; }; functions: Record; types: Record; }" + ], + "description": [], + "label": "extendContext", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L37" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "pureTransitions", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-common.pureSelectors", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.pureSelectors.getFunction", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L50" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } + ], + "description": [], + "label": "getFunction", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L50" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureSelectors.getType", + "type": "Function", + "children": [ + { + "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": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L51" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => (id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + } + ], + "description": [], + "label": "getType", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L51" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureSelectors.getContext", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ context }", + "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": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L52" + } + } + ], + "signature": [ + "({ context }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => () => Record" + ], + "description": [], + "label": "getContext", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L52" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "pureSelectors", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-common.executionPureTransitions", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.executionPureTransitions.start", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L57" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => () => { state: \"pending\"; ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; result?: any; error?: Error | undefined; functions: Record; types: Record; context: Record; }" + ], + "description": [], + "label": "start", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L57" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.executionPureTransitions.setResult", + "type": "Function", + "children": [ + { + "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": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L61" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => (result: any) => { state: \"result\"; result: any; ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; error?: Error | undefined; functions: Record; types: Record; context: Record; }" + ], + "description": [], + "label": "setResult", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L61" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.executionPureTransitions.setError", + "type": "Function", + "children": [ + { + "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": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L66" + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + ") => (error: Error) => { state: \"error\"; error: Error; ast: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; result?: any; functions: Record; types: Record; context: Record; }" + ], + "description": [], + "label": "setError", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L66" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "executionPureTransitions", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L56" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx new file mode 100644 index 0000000000000..a57e91bf2a333 --- /dev/null +++ b/api_docs/expressions.mdx @@ -0,0 +1,79 @@ +--- +id: kibExpressionsPluginApi +slug: /kibana-dev-docs/expressionsPluginApi +title: expressions +image: https://source.unsplash.com/400x175/?github +summary: API docs for the expressions plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import expressionsObj from './expressions.json'; + +## Client + +### Setup + + +### Start + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/features.json b/api_docs/features.json new file mode 100644 index 0000000000000..4e462e9905b7c --- /dev/null +++ b/api_docs/features.json @@ -0,0 +1,3713 @@ +{ + "id": "features", + "client": { + "classes": [ + { + "id": "def-public.KibanaFeature", + "type": "Class", + "tags": [], + "label": "KibanaFeature", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.KibanaFeature.subFeatures", + "type": "Array", + "label": "subFeatures", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeature", + "text": "SubFeature" + }, + "[]" + ] + }, + { + "id": "def-public.KibanaFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "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: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + }, + { + "id": "def-public.KibanaFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146" + } + }, + { + "id": "def-public.KibanaFeature.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150" + } + }, + { + "id": "def-public.KibanaFeature.order", + "type": "number", + "label": "order", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154" + }, + "signature": [ + "number | undefined" + ] + }, + { + "id": "def-public.KibanaFeature.category", + "type": "Object", + "label": "category", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158" + }, + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ] + }, + { + "id": "def-public.KibanaFeature.app", + "type": "Object", + "label": "app", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "id": "def-public.KibanaFeature.catalogue", + "type": "Object", + "label": "catalogue", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-public.KibanaFeature.management", + "type": "Object", + "label": "management", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170" + }, + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ] + }, + { + "id": "def-public.KibanaFeature.minimumLicense", + "type": "CompoundType", + "label": "minimumLicense", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "id": "def-public.KibanaFeature.privileges", + "type": "CompoundType", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178" + }, + "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" + ] + }, + { + "id": "def-public.KibanaFeature.alerting", + "type": "Object", + "label": "alerting", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-public.KibanaFeature.excludeFromBasePrivileges", + "type": "boolean", + "label": "excludeFromBasePrivileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186" + } + }, + { + "id": "def-public.KibanaFeature.reserved", + "type": "Object", + "label": "reserved", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190" + }, + "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" + ] + }, + { + "id": "def-public.KibanaFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeatureConfig", + "text": "KibanaFeatureConfig" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.KibanaFeatureConfig", + "type": "Interface", + "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": [], + "children": [ + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33" + } + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.category", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + } + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.order", + "type": "number", + "label": "order", + "description": [ + "\nAn ordinal used to sort features relative to one another for display." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.excludeFromBasePrivileges", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.minimumLicense", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.app", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.KibanaFeatureConfig.management", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.catalogue", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113" + }, + "signature": [ + "{ all: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; read: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; } | null" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.subFeatures", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeatureConfig", + "text": "SubFeatureConfig" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.KibanaFeatureConfig.privilegesTooltip", + "type": "string", + "label": "privilegesTooltip", + "description": [ + "\nOptional message to display on the Role Management screen when configuring permissions for this feature." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "private" + ], + "id": "def-public.KibanaFeatureConfig.reserved", + "type": "Object", + "label": "reserved", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131" + }, + "signature": [ + "{ description: string; privileges: readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ReservedKibanaPrivilege", + "text": "ReservedKibanaPrivilege" + }, + "[]; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FeatureKibanaPrivileges", + "type": "Interface", + "label": "FeatureKibanaPrivileges", + "description": [ + "\nFeature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FeatureKibanaPrivileges.excludeFromBasePrivileges", + "type": "CompoundType", + "label": "excludeFromBasePrivileges", + "description": [ + "\nWhether or not this specific privilege should be excluded from the base privileges." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.FeatureKibanaPrivileges.management", + "type": "Object", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureKibanaPrivileges.catalogue", + "type": "Object", + "label": "catalogue", + "description": [ + "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.FeatureKibanaPrivileges.api", + "type": "Object", + "label": "api", + "description": [ + "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.FeatureKibanaPrivileges.app", + "type": "Object", + "label": "app", + "description": [ + "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureKibanaPrivileges.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84" + }, + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureKibanaPrivileges.savedObject", + "type": "Object", + "label": "savedObject", + "description": [ + "\nIf your feature requires access to specific saved objects, then specify your access needs here." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110" + }, + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ] + }, + { + "tags": [ + "example", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153" + }, + "signature": [ + "readonly string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SubFeatureConfig", + "type": "Interface", + "label": "SubFeatureConfig", + "description": [ + "\nConfiguration for a sub-feature." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SubFeatureConfig.name", + "type": "string", + "label": "name", + "description": [ + "Display name for this sub-feature" + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.SubFeatureConfig.privilegeGroups", + "type": "Object", + "label": "privilegeGroups", + "description": [ + "Collection of privilege groups" + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L20" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupConfig", + "text": "SubFeaturePrivilegeGroupConfig" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SubFeaturePrivilegeConfig", + "type": "Interface", + "label": "SubFeaturePrivilegeConfig", + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeConfig", + "text": "SubFeaturePrivilegeConfig" + }, + " extends Pick<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + ", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">" + ], + "description": [ + "\nConfiguration for a sub-feature privilege." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.id", + "type": "string", + "label": "id", + "description": [ + "\nIdentifier for this privilege. Must be unique across all other privileges within a feature." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L61" + } + }, + { + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nThe display name for this privilege." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L66" + } + }, + { + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.includeIn", + "type": "CompoundType", + "label": "includeIn", + "description": [ + "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L72" + }, + "signature": [ + "\"read\" | \"all\" | \"none\"" + ] + }, + { + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.minimumLicense", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L79" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L56" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.FeaturesPluginSetup", + "type": "Type", + "label": "FeaturesPluginSetup", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/public/plugin.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/public/plugin.ts#L27" + }, + "signature": [ + "void" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.FeaturesPluginStart", + "type": "Type", + "label": "FeaturesPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/public/plugin.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/public/plugin.ts#L28" + }, + "signature": [ + "{ getFeatures: () => Promise<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + }, + "[]>; }" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "id": "def-server.KibanaFeature", + "type": "Class", + "tags": [], + "label": "KibanaFeature", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.KibanaFeature.subFeatures", + "type": "Array", + "label": "subFeatures", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeature", + "text": "SubFeature" + }, + "[]" + ] + }, + { + "id": "def-server.KibanaFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "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: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + }, + { + "id": "def-server.KibanaFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146" + } + }, + { + "id": "def-server.KibanaFeature.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150" + } + }, + { + "id": "def-server.KibanaFeature.order", + "type": "number", + "label": "order", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154" + }, + "signature": [ + "number | undefined" + ] + }, + { + "id": "def-server.KibanaFeature.category", + "type": "Object", + "label": "category", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158" + }, + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ] + }, + { + "id": "def-server.KibanaFeature.app", + "type": "Object", + "label": "app", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "id": "def-server.KibanaFeature.catalogue", + "type": "Object", + "label": "catalogue", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-server.KibanaFeature.management", + "type": "Object", + "label": "management", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170" + }, + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ] + }, + { + "id": "def-server.KibanaFeature.minimumLicense", + "type": "CompoundType", + "label": "minimumLicense", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "id": "def-server.KibanaFeature.privileges", + "type": "CompoundType", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178" + }, + "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" + ] + }, + { + "id": "def-server.KibanaFeature.alerting", + "type": "Object", + "label": "alerting", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-server.KibanaFeature.excludeFromBasePrivileges", + "type": "boolean", + "label": "excludeFromBasePrivileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186" + } + }, + { + "id": "def-server.KibanaFeature.reserved", + "type": "Object", + "label": "reserved", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190" + }, + "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" + ] + }, + { + "id": "def-server.KibanaFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeatureConfig", + "text": "KibanaFeatureConfig" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchFeature", + "type": "Class", + "tags": [], + "label": "ElasticsearchFeature", + "description": [], + "children": [ + { + "id": "def-server.ElasticsearchFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Readonly<{ id: string; management?: Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined; catalogue?: ", + "RecursiveReadonlyArray", + " | undefined; privileges: ", + "RecursiveReadonlyArray", + "<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + ">; }>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65" + } + }, + { + "id": "def-server.ElasticsearchFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L67" + } + }, + { + "id": "def-server.ElasticsearchFeature.catalogue", + "type": "Object", + "label": "catalogue", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L71" + }, + "signature": [ + "RecursiveReadonlyArray", + " | undefined" + ] + }, + { + "id": "def-server.ElasticsearchFeature.management", + "type": "Object", + "label": "management", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L75" + }, + "signature": [ + "Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined" + ] + }, + { + "id": "def-server.ElasticsearchFeature.privileges", + "type": "Object", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L79" + }, + "signature": [ + "RecursiveReadonlyArray", + "<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + ">" + ] + }, + { + "id": "def-server.ElasticsearchFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeatureConfig", + "text": "ElasticsearchFeatureConfig" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L83" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L64" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-server.KibanaFeatureConfig", + "type": "Interface", + "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": [], + "children": [ + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27" + } + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33" + } + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.category", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + } + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.order", + "type": "number", + "label": "order", + "description": [ + "\nAn ordinal used to sort features relative to one another for display." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.excludeFromBasePrivileges", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.minimumLicense", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.app", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.KibanaFeatureConfig.management", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.catalogue", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113" + }, + "signature": [ + "{ all: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; read: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; } | null" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.subFeatures", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeatureConfig", + "text": "SubFeatureConfig" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.privilegesTooltip", + "type": "string", + "label": "privilegesTooltip", + "description": [ + "\nOptional message to display on the Role Management screen when configuring permissions for this feature." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "private" + ], + "id": "def-server.KibanaFeatureConfig.reserved", + "type": "Object", + "label": "reserved", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131" + }, + "signature": [ + "{ description: string; privileges: readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ReservedKibanaPrivilege", + "text": "ReservedKibanaPrivilege" + }, + "[]; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FeatureKibanaPrivileges", + "type": "Interface", + "label": "FeatureKibanaPrivileges", + "description": [ + "\nFeature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FeatureKibanaPrivileges.excludeFromBasePrivileges", + "type": "CompoundType", + "label": "excludeFromBasePrivileges", + "description": [ + "\nWhether or not this specific privilege should be excluded from the base privileges." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.FeatureKibanaPrivileges.management", + "type": "Object", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FeatureKibanaPrivileges.catalogue", + "type": "Object", + "label": "catalogue", + "description": [ + "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.FeatureKibanaPrivileges.api", + "type": "Object", + "label": "api", + "description": [ + "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.FeatureKibanaPrivileges.app", + "type": "Object", + "label": "app", + "description": [ + "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FeatureKibanaPrivileges.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84" + }, + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FeatureKibanaPrivileges.savedObject", + "type": "Object", + "label": "savedObject", + "description": [ + "\nIf your feature requires access to specific saved objects, then specify your access needs here." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110" + }, + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ] + }, + { + "tags": [ + "example", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153" + }, + "signature": [ + "readonly string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ElasticsearchFeatureConfig", + "type": "Interface", + "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": [], + "children": [ + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L23" + } + }, + { + "tags": [ + "example" + ], + "id": "def-server.ElasticsearchFeatureConfig.management", + "type": "Object", + "label": "management", + "description": [ + "\nManagement sections associated with this feature.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L36" + }, + "signature": [ + "{ [sectionId: string]: string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchFeatureConfig.catalogue", + "type": "Array", + "label": "catalogue", + "description": [ + "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L44" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L61" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FeatureElasticsearchPrivileges", + "type": "Interface", + "label": "FeatureElasticsearchPrivileges", + "description": [ + "\nElasticsearch Feature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FeatureElasticsearchPrivileges.requiredClusterPrivileges", + "type": "Array", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L17" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.FeatureElasticsearchPrivileges.requiredIndexPrivileges", + "type": "Object", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L38" + }, + "signature": [ + "{ [indexName: string]: string[]; } | undefined" + ] + }, + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L50" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L72" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginSetupContract", + "type": "Interface", + "label": "PluginSetupContract", + "description": [ + "\nDescribes public Features plugin contract returned at the `setup` stage." + ], + "tags": [], + "children": [ + { + "id": "def-server.PluginSetupContract.registerKibanaFeature", + "type": "Function", + "label": "registerKibanaFeature", + "signature": [ + "(feature: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeatureConfig", + "text": "KibanaFeatureConfig" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "feature", + "isRequired": true, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeatureConfig", + "text": "KibanaFeatureConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L34" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L34" + } + }, + { + "id": "def-server.PluginSetupContract.registerElasticsearchFeature", + "type": "Function", + "label": "registerElasticsearchFeature", + "signature": [ + "(feature: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeatureConfig", + "text": "ElasticsearchFeatureConfig" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "feature", + "isRequired": true, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeatureConfig", + "text": "ElasticsearchFeatureConfig" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L35" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L35" + } + }, + { + "id": "def-server.PluginSetupContract.getKibanaFeatures", + "type": "Function", + "label": "getKibanaFeatures", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L41" + } + }, + { + "id": "def-server.PluginSetupContract.getElasticsearchFeatures", + "type": "Function", + "label": "getElasticsearchFeatures", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeature", + "text": "ElasticsearchFeature" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L47" + } + }, + { + "id": "def-server.PluginSetupContract.getFeaturesUICapabilities", + "type": "Function", + "label": "getFeaturesUICapabilities", + "signature": [ + "() => ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.Capabilities", + "text": "Capabilities" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L48" + } + } + ], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PluginStartContract", + "type": "Interface", + "label": "PluginStartContract", + "description": [], + "tags": [], + "children": [ + { + "id": "def-server.PluginStartContract.getElasticsearchFeatures", + "type": "Function", + "label": "getElasticsearchFeatures", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeature", + "text": "ElasticsearchFeature" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L52" + } + }, + { + "id": "def-server.PluginStartContract.getKibanaFeatures", + "type": "Function", + "label": "getKibanaFeatures", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeature", + "text": "KibanaFeature" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L53" + } + } + ], + "source": { + "path": "x-pack/plugins/features/server/plugin.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L51" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [ + { + "tags": [], + "id": "def-server.uiCapabilitiesRegex", + "type": "Object", + "label": "uiCapabilitiesRegex", + "description": [], + "source": { + "path": "x-pack/plugins/features/server/feature_schema.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/feature_schema.ts#L23" + }, + "signature": [ + "RegExp" + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [ + { + "id": "def-common.ElasticsearchFeature", + "type": "Class", + "tags": [], + "label": "ElasticsearchFeature", + "description": [], + "children": [ + { + "id": "def-common.ElasticsearchFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Readonly<{ id: string; management?: Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined; catalogue?: ", + "RecursiveReadonlyArray", + " | undefined; privileges: ", + "RecursiveReadonlyArray", + "<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + ">; }>" + ], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65" + } + }, + { + "id": "def-common.ElasticsearchFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L67" + } + }, + { + "id": "def-common.ElasticsearchFeature.catalogue", + "type": "Object", + "label": "catalogue", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L71" + }, + "signature": [ + "RecursiveReadonlyArray", + " | undefined" + ] + }, + { + "id": "def-common.ElasticsearchFeature.management", + "type": "Object", + "label": "management", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L75" + }, + "signature": [ + "Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined" + ] + }, + { + "id": "def-common.ElasticsearchFeature.privileges", + "type": "Object", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L79" + }, + "signature": [ + "RecursiveReadonlyArray", + "<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + ">" + ] + }, + { + "id": "def-common.ElasticsearchFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ElasticsearchFeatureConfig", + "text": "ElasticsearchFeatureConfig" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L83" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KibanaFeature", + "type": "Class", + "tags": [], + "label": "KibanaFeature", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.KibanaFeature.subFeatures", + "type": "Array", + "label": "subFeatures", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeature", + "text": "SubFeature" + }, + "[]" + ] + }, + { + "id": "def-common.KibanaFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "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: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140" + } + }, + { + "id": "def-common.KibanaFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146" + } + }, + { + "id": "def-common.KibanaFeature.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150" + } + }, + { + "id": "def-common.KibanaFeature.order", + "type": "number", + "label": "order", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154" + }, + "signature": [ + "number | undefined" + ] + }, + { + "id": "def-common.KibanaFeature.category", + "type": "Object", + "label": "category", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158" + }, + "signature": [ + "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" + ] + }, + { + "id": "def-common.KibanaFeature.app", + "type": "Object", + "label": "app", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "id": "def-common.KibanaFeature.catalogue", + "type": "Object", + "label": "catalogue", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-common.KibanaFeature.management", + "type": "Object", + "label": "management", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170" + }, + "signature": [ + "Readonly<{ [x: string]: readonly string[]; }> | undefined" + ] + }, + { + "id": "def-common.KibanaFeature.minimumLicense", + "type": "CompoundType", + "label": "minimumLicense", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "id": "def-common.KibanaFeature.privileges", + "type": "CompoundType", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178" + }, + "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" + ] + }, + { + "id": "def-common.KibanaFeature.alerting", + "type": "Object", + "label": "alerting", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "id": "def-common.KibanaFeature.excludeFromBasePrivileges", + "type": "boolean", + "label": "excludeFromBasePrivileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186" + } + }, + { + "id": "def-common.KibanaFeature.reserved", + "type": "Object", + "label": "reserved", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190" + }, + "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" + ] + }, + { + "id": "def-common.KibanaFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.KibanaFeatureConfig", + "text": "KibanaFeatureConfig" + } + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 194, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubFeature", + "type": "Class", + "tags": [], + "label": "SubFeature", + "description": [], + "children": [ + { + "id": "def-common.SubFeature.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L83" + } + }, + { + "id": "def-common.SubFeature.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L85" + } + }, + { + "id": "def-common.SubFeature.privilegeGroups", + "type": "Object", + "label": "privilegeGroups", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L89" + }, + "signature": [ + "readonly Readonly<{ groupType: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" + ] + }, + { + "id": "def-common.SubFeature.toRaw", + "type": "Function", + "label": "toRaw", + "signature": [ + "() => { name: string; privilegeGroups: readonly Readonly<{ groupType: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "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; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; 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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L93" + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L82" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-common.FeatureElasticsearchPrivileges", + "type": "Interface", + "label": "FeatureElasticsearchPrivileges", + "description": [ + "\nElasticsearch Feature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FeatureElasticsearchPrivileges.requiredClusterPrivileges", + "type": "Array", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L17" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-common.FeatureElasticsearchPrivileges.requiredIndexPrivileges", + "type": "Object", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L38" + }, + "signature": [ + "{ [indexName: string]: string[]; } | undefined" + ] + }, + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L50" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L72" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FeatureKibanaPrivileges", + "type": "Interface", + "label": "FeatureKibanaPrivileges", + "description": [ + "\nFeature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FeatureKibanaPrivileges.excludeFromBasePrivileges", + "type": "CompoundType", + "label": "excludeFromBasePrivileges", + "description": [ + "\nWhether or not this specific privilege should be excluded from the base privileges." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-common.FeatureKibanaPrivileges.management", + "type": "Object", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FeatureKibanaPrivileges.catalogue", + "type": "Object", + "label": "catalogue", + "description": [ + "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-common.FeatureKibanaPrivileges.api", + "type": "Object", + "label": "api", + "description": [ + "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-common.FeatureKibanaPrivileges.app", + "type": "Object", + "label": "app", + "description": [ + "\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FeatureKibanaPrivileges.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84" + }, + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FeatureKibanaPrivileges.savedObject", + "type": "Object", + "label": "savedObject", + "description": [ + "\nIf your feature requires access to specific saved objects, then specify your access needs here." + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110" + }, + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ] + }, + { + "tags": [ + "example", + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153" + }, + "signature": [ + "readonly string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ElasticsearchFeatureConfig", + "type": "Interface", + "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": [], + "children": [ + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L23" + } + }, + { + "tags": [ + "example" + ], + "id": "def-common.ElasticsearchFeatureConfig.management", + "type": "Object", + "label": "management", + "description": [ + "\nManagement sections associated with this feature.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L36" + }, + "signature": [ + "{ [sectionId: string]: string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ElasticsearchFeatureConfig.catalogue", + "type": "Array", + "label": "catalogue", + "description": [ + "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n" + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L44" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L61" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KibanaFeatureConfig", + "type": "Interface", + "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": [], + "children": [ + { + "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" + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27" + } + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33" + } + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.category", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + } + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.order", + "type": "number", + "label": "order", + "description": [ + "\nAn ordinal used to sort features relative to one another for display." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.excludeFromBasePrivileges", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.minimumLicense", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.app", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68" + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-common.KibanaFeatureConfig.management", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84" + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.catalogue", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.alerting", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99" + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [ + "example", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113" + }, + "signature": [ + "{ all: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; read: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; } | null" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.subFeatures", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeatureConfig", + "text": "SubFeatureConfig" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.KibanaFeatureConfig.privilegesTooltip", + "type": "string", + "label": "privilegesTooltip", + "description": [ + "\nOptional message to display on the Role Management screen when configuring permissions for this feature." + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "private" + ], + "id": "def-common.KibanaFeatureConfig.reserved", + "type": "Object", + "label": "reserved", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131" + }, + "signature": [ + "{ description: string; privileges: readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ReservedKibanaPrivilege", + "text": "ReservedKibanaPrivilege" + }, + "[]; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubFeatureConfig", + "type": "Interface", + "label": "SubFeatureConfig", + "description": [ + "\nConfiguration for a sub-feature." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SubFeatureConfig.name", + "type": "string", + "label": "name", + "description": [ + "Display name for this sub-feature" + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.SubFeatureConfig.privilegeGroups", + "type": "Object", + "label": "privilegeGroups", + "description": [ + "Collection of privilege groups" + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L20" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupConfig", + "text": "SubFeaturePrivilegeGroupConfig" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubFeaturePrivilegeConfig", + "type": "Interface", + "label": "SubFeaturePrivilegeConfig", + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeConfig", + "text": "SubFeaturePrivilegeConfig" + }, + " extends Pick<", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + ", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">" + ], + "description": [ + "\nConfiguration for a sub-feature privilege." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeConfig.id", + "type": "string", + "label": "id", + "description": [ + "\nIdentifier for this privilege. Must be unique across all other privileges within a feature." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L61" + } + }, + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nThe display name for this privilege." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L66" + } + }, + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeConfig.includeIn", + "type": "CompoundType", + "label": "includeIn", + "description": [ + "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L72" + }, + "signature": [ + "\"read\" | \"all\" | \"none\"" + ] + }, + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeConfig.minimumLicense", + "type": "CompoundType", + "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." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L79" + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SubFeaturePrivilegeGroupConfig", + "type": "Interface", + "label": "SubFeaturePrivilegeGroupConfig", + "description": [ + "\nConfiguration for a sub-feature privilege group." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeGroupConfig.groupType", + "type": "CompoundType", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L45" + }, + "signature": [ + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeGroupType", + "text": "SubFeaturePrivilegeGroupType" + } + ] + }, + { + "tags": [], + "id": "def-common.SubFeaturePrivilegeGroupConfig.privileges", + "type": "Object", + "label": "privileges", + "description": [ + "\nThe privileges which belong to this group." + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L50" + }, + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeaturePrivilegeConfig", + "text": "SubFeaturePrivilegeConfig" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L36" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-common.SubFeaturePrivilegeGroupType", + "type": "Type", + "label": "SubFeaturePrivilegeGroupType", + "tags": [], + "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": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L31" + }, + "signature": [ + "\"mutually_exclusive\" | \"independent\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/features.mdx b/api_docs/features.mdx new file mode 100644 index 0000000000000..99776f6930159 --- /dev/null +++ b/api_docs/features.mdx @@ -0,0 +1,49 @@ +--- +id: kibFeaturesPluginApi +slug: /kibana-dev-docs/featuresPluginApi +title: features +image: https://source.unsplash.com/400x175/?github +summary: API docs for the features plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import featuresObj from './features.json'; + +## Client + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + +## Server + +### Objects + + +### Classes + + +### Interfaces + + +## Common + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json new file mode 100644 index 0000000000000..f74ad69eb9f9a --- /dev/null +++ b/api_docs/file_upload.json @@ -0,0 +1,1797 @@ +{ + "id": "fileUpload", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.FileUploadComponentProps", + "type": "Interface", + "label": "FileUploadComponentProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FileUploadComponentProps.isIndexingTriggered", + "type": "boolean", + "label": "isIndexingTriggered", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onFileUpload", + "type": "Function", + "label": "onFileUpload", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L15" + }, + "signature": [ + "(geojsonFile: GeoJSON.FeatureCollection, name: string) => void" + ] + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onFileRemove", + "type": "Function", + "label": "onFileRemove", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L16" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onIndexReady", + "type": "Function", + "label": "onIndexReady", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L17" + }, + "signature": [ + "(indexReady: boolean) => void" + ] + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onIndexingComplete", + "type": "Function", + "label": "onIndexingComplete", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L18" + }, + "signature": [ + "(results: { indexDataResp: ", + { + "pluginId": "fileUpload", + "scope": "public", + "docId": "kibFileUploadPluginApi", + "section": "def-public.ImportResults", + "text": "ImportResults" + }, + "; indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "; }) => void" + ] + }, + { + "tags": [], + "id": "def-public.FileUploadComponentProps.onIndexingError", + "type": "Function", + "label": "onIndexingError", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L22" + }, + "signature": [ + "() => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L13" + }, + "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": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L9" + } + }, + { + "tags": [], + "id": "def-public.ImportResponse.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L10" + } + }, + { + "tags": [], + "id": "def-public.ImportResponse.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L11" + }, + "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": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L12" + }, + "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": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.ImportResponse.failures", + "type": "Array", + "label": "failures", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L14" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportFailure", + "text": "ImportFailure" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.ImportResponse.error", + "type": "Any", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L15" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.ImportResponse.ingestError", + "type": "CompoundType", + "label": "ingestError", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L16" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L8" + }, + "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": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.ImportFailure.reason", + "type": "string", + "label": "reason", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.ImportFailure.doc", + "type": "CompoundType", + "label": "doc", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L22" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportDoc", + "text": "ImportDoc" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L19" + }, + "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": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L26" + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Settings", + "type": "Interface", + "label": "Settings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Settings.pipeline", + "type": "string", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Settings.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L33" + } + }, + { + "tags": [], + "id": "def-public.Settings.body", + "type": "Array", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L34" + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-public.Settings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L35" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L31" + }, + "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": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L39" + }, + "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": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L42" + }, + "signature": [ + "{ [key: string]: any; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L38" + }, + "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": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L48" + } + }, + { + "tags": [], + "id": "def-public.IngestPipelineWrapper.pipeline", + "type": "Object", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L49" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IngestPipeline", + "type": "Interface", + "label": "IngestPipeline", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IngestPipeline.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L53" + } + }, + { + "tags": [], + "id": "def-public.IngestPipeline.processors", + "type": "Array", + "label": "processors", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L54" + }, + "signature": [ + "any[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ImportConfig", + "type": "Interface", + "label": "ImportConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ImportConfig.settings", + "type": "Object", + "label": "settings", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L11" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Settings", + "text": "Settings" + } + ] + }, + { + "tags": [], + "id": "def-public.ImportConfig.mappings", + "type": "Object", + "label": "mappings", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L12" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + } + ] + }, + { + "tags": [], + "id": "def-public.ImportConfig.pipeline", + "type": "Object", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L13" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ImportResults", + "type": "Interface", + "label": "ImportResults", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ImportResults.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.ImportResults.failures", + "type": "Array", + "label": "failures", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L18" + }, + "signature": [ + "any[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportResults.docCount", + "type": "number", + "label": "docCount", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L19" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportResults.error", + "type": "Any", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L20" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CreateDocsResponse", + "type": "Interface", + "label": "CreateDocsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CreateDocsResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.remainder", + "type": "number", + "label": "remainder", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L25" + } + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.docs", + "type": "Array", + "label": "docs", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L26" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportDoc", + "text": "ImportDoc" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.error", + "type": "Any", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L27" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ImportFactoryOptions", + "type": "Interface", + "label": "ImportFactoryOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ImportFactoryOptions.excludeLinesPattern", + "type": "string", + "label": "excludeLinesPattern", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L31" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportFactoryOptions.multilineStartPattern", + "type": "string", + "label": "multilineStartPattern", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportFactoryOptions.importConfig", + "type": "Object", + "label": "importConfig", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L33" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "public", + "docId": "kibFileUploadPluginApi", + "section": "def-public.ImportConfig", + "text": "ImportConfig" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L30" + }, + "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": [ + { + "type": "Object", + "label": "data", + "isRequired": true, + "signature": [ + "ArrayBuffer" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L37" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L37" + } + }, + { + "id": "def-public.IImporter.initializeImport", + "type": "Function", + "label": "initializeImport", + "signature": [ + "(index: string, settings: ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Settings", + "text": "Settings" + }, + ", mappings: ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + ", pipeline: ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + }, + ") => Promise<", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportResponse", + "text": "ImportResponse" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "index", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L39" + } + }, + { + "type": "Object", + "label": "settings", + "isRequired": true, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Settings", + "text": "Settings" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L40" + } + }, + { + "type": "Object", + "label": "mappings", + "isRequired": true, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L41" + } + }, + { + "type": "Object", + "label": "pipeline", + "isRequired": true, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L42" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L38" + } + }, + { + "id": "def-public.IImporter.import", + "type": "Function", + "label": "import", + "signature": [ + "(id: string, index: string, pipelineId: string, setImportProgress: (progress: number) => void) => Promise<", + { + "pluginId": "fileUpload", + "scope": "public", + "docId": "kibFileUploadPluginApi", + "section": "def-public.ImportResults", + "text": "ImportResults" + }, + ">" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L45" + } + }, + { + "type": "string", + "label": "index", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L46" + } + }, + { + "type": "string", + "label": "pipelineId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L47" + } + }, + { + "type": "Function", + "label": "setImportProgress", + "isRequired": true, + "signature": [ + "(progress: number) => void" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L48" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L44" + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L36" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.MB", + "type": "number", + "label": "MB", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8" + }, + "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": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L9" + }, + "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": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10" + }, + "signature": [ + "104857600" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.ABSOLUTE_MAX_FILE_SIZE_BYTES", + "type": "number", + "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12" + }, + "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": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L13" + }, + "signature": [ + "\"0,0.[0] b\"" + ], + "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": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L17" + }, + "signature": [ + "\"ml-file-data-visualizer\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ImportDoc", + "type": "Type", + "label": "ImportDoc", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L29" + }, + "signature": [ + "string | object | ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Doc", + "text": "Doc" + } + ], + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "id": "def-public.FileUploadPluginStart", + "type": "Type", + "label": "FileUploadPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/plugin.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/plugin.ts#L20" + }, + "signature": [ + "FileUploadStartApi" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-common.ImportResponse", + "type": "Interface", + "label": "ImportResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ImportResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L9" + } + }, + { + "tags": [], + "id": "def-common.ImportResponse.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.ImportResponse.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L11" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ImportResponse.pipelineId", + "type": "string", + "label": "pipelineId", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L12" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ImportResponse.docCount", + "type": "number", + "label": "docCount", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.ImportResponse.failures", + "type": "Array", + "label": "failures", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L14" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportFailure", + "text": "ImportFailure" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.ImportResponse.error", + "type": "Any", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L15" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.ImportResponse.ingestError", + "type": "CompoundType", + "label": "ingestError", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L16" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ImportFailure", + "type": "Interface", + "label": "ImportFailure", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ImportFailure.item", + "type": "number", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.ImportFailure.reason", + "type": "string", + "label": "reason", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.ImportFailure.doc", + "type": "CompoundType", + "label": "doc", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L22" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportDoc", + "text": "ImportDoc" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Doc", + "type": "Interface", + "label": "Doc", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Doc.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L26" + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Settings", + "type": "Interface", + "label": "Settings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Settings.pipeline", + "type": "string", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L32" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Settings.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L33" + } + }, + { + "tags": [], + "id": "def-common.Settings.body", + "type": "Array", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L34" + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-common.Settings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L35" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Mappings", + "type": "Interface", + "label": "Mappings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Mappings._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L39" + }, + "signature": [ + "{ created_by: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Mappings.properties", + "type": "Object", + "label": "properties", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L42" + }, + "signature": [ + "{ [key: string]: any; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L38" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IngestPipelineWrapper", + "type": "Interface", + "label": "IngestPipelineWrapper", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IngestPipelineWrapper.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L48" + } + }, + { + "tags": [], + "id": "def-common.IngestPipelineWrapper.pipeline", + "type": "Object", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L49" + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IngestPipeline", + "type": "Interface", + "label": "IngestPipeline", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IngestPipeline.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L53" + } + }, + { + "tags": [], + "id": "def-common.IngestPipeline.processors", + "type": "Array", + "label": "processors", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L54" + }, + "signature": [ + "any[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L52" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.MB", + "type": "number", + "label": "MB", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_FILE_SIZE", + "type": "string", + "label": "MAX_FILE_SIZE", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L9" + }, + "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_upload/common/constants.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10" + }, + "signature": [ + "104857600" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES", + "type": "number", + "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12" + }, + "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_upload/common/constants.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L13" + }, + "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_upload/common/constants.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L17" + }, + "signature": [ + "\"ml-file-data-visualizer\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ImportDoc", + "type": "Type", + "label": "ImportDoc", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L29" + }, + "signature": [ + "string | object | ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Doc", + "text": "Doc" + } + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx new file mode 100644 index 0000000000000..f17e9c2472c12 --- /dev/null +++ b/api_docs/file_upload.mdx @@ -0,0 +1,32 @@ +--- +id: kibFileUploadPluginApi +slug: /kibana-dev-docs/fileUploadPluginApi +title: fileUpload +image: https://source.unsplash.com/400x175/?github +summary: API docs for the fileUpload plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import fileUploadObj from './file_upload.json'; + +## Client + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/fleet.json b/api_docs/fleet.json new file mode 100644 index 0000000000000..381818efb9f33 --- /dev/null +++ b/api_docs/fleet.json @@ -0,0 +1,17178 @@ +{ + "id": "fleet", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.pkgKeyFromPackageInfo", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "packageInfo", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts#L9" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts#L8" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.NewPackagePolicy", + "type": "Interface", + "label": "NewPackagePolicy", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.NewPackagePolicy.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L50" + } + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L51" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L52" + } + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L53" + } + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.policy_id", + "type": "string", + "label": "policy_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L54" + } + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.output_id", + "type": "string", + "label": "output_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L55" + } + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.package", + "type": "Object", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L56" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.NewPackagePolicy.inputs", + "type": "Array", + "label": "inputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L57" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-public.CreatePackagePolicyRouteState", + "type": "Interface", + "label": "CreatePackagePolicyRouteState", + "description": [ + "\nSupported routing state for the create package policy page routes" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CreatePackagePolicyRouteState.onSaveNavigateTo", + "type": "CompoundType", + "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": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L16" + }, + "signature": [ + "[appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined] | ((newPackagePolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + ") => [appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined]) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CreatePackagePolicyRouteState.onCancelNavigateTo", + "type": "Object", + "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": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L20" + }, + "signature": [ + "[appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CreatePackagePolicyRouteState.onCancelUrl", + "type": "string", + "label": "onCancelUrl", + "description": [ + "Url to be used on cancel links" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L22" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AgentPolicyDetailsDeployAgentAction", + "type": "Interface", + "label": "AgentPolicyDetailsDeployAgentAction", + "description": [ + "\nSupported routing state for the agent policy details page routes with deploy agents action" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AgentPolicyDetailsDeployAgentAction.onDoneNavigateTo", + "type": "Object", + "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": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L30" + }, + "signature": [ + "[appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-public.AgentDetailsReassignPolicyAction", + "type": "Interface", + "label": "AgentDetailsReassignPolicyAction", + "description": [ + "\nSupported routing state for the agent policy details page routes with deploy agents action" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AgentDetailsReassignPolicyAction.onDoneNavigateTo", + "type": "Object", + "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": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L38" + }, + "signature": [ + "[appId: string, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.NavigateToAppOptions", + "text": "NavigateToAppOptions" + }, + " | undefined] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UIExtensionsStorage", + "type": "Interface", + "label": "UIExtensionsStorage", + "description": [ + "Internal storage for registered UI Extension Points" + ], + "tags": [], + "children": [ + { + "id": "def-public.UIExtensionsStorage.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L16" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyEditExtensionComponentProps", + "type": "Interface", + "label": "PackagePolicyEditExtensionComponentProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackagePolicyEditExtensionComponentProps.policy", + "type": "Object", + "label": "policy", + "description": [ + "The current integration policy being edited" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L27" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + } + ] + }, + { + "tags": [], + "id": "def-public.PackagePolicyEditExtensionComponentProps.newPolicy", + "type": "Object", + "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": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L29" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ] + }, + { + "tags": [], + "id": "def-public.PackagePolicyEditExtensionComponentProps.onChange", + "type": "Function", + "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": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L38" + }, + "signature": [ + "(opts: { isValid: boolean; updatedPolicy: Partial<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ">; }) => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyEditExtension", + "type": "Interface", + "label": "PackagePolicyEditExtension", + "description": [ + "Extension point registration contract for Integration Policy Edit views" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackagePolicyEditExtension.package", + "type": "string", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L48" + } + }, + { + "tags": [], + "id": "def-public.PackagePolicyEditExtension.view", + "type": "string", + "label": "view", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L49" + }, + "signature": [ + "\"package-policy-edit\"" + ] + }, + { + "tags": [], + "id": "def-public.PackagePolicyEditExtension.component", + "type": "Function", + "label": "component", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L50" + }, + "signature": [ + "React.LazyExoticComponent>" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L47" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyCreateExtensionComponentProps", + "type": "Interface", + "label": "PackagePolicyCreateExtensionComponentProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackagePolicyCreateExtensionComponentProps.newPolicy", + "type": "Object", + "label": "newPolicy", + "description": [ + "The integration policy being created" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L61" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ] + }, + { + "tags": [], + "id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange", + "type": "Function", + "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": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L66" + }, + "signature": [ + "(opts: { isValid: boolean; updatedPolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + "; }) => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L59" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyCreateExtension", + "type": "Interface", + "label": "PackagePolicyCreateExtension", + "description": [ + "Extension point registration contract for Integration Policy Create views" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackagePolicyCreateExtension.package", + "type": "string", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L76" + } + }, + { + "tags": [], + "id": "def-public.PackagePolicyCreateExtension.view", + "type": "string", + "label": "view", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L77" + }, + "signature": [ + "\"package-policy-create\"" + ] + }, + { + "tags": [], + "id": "def-public.PackagePolicyCreateExtension.component", + "type": "Function", + "label": "component", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L78" + }, + "signature": [ + "React.LazyExoticComponent>" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L75" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackageCustomExtensionComponentProps", + "type": "Interface", + "label": "PackageCustomExtensionComponentProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackageCustomExtensionComponentProps.pkgkey", + "type": "string", + "label": "pkgkey", + "description": [ + "The package key value that should be used used for URLs" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L88" + } + }, + { + "tags": [], + "id": "def-public.PackageCustomExtensionComponentProps.packageInfo", + "type": "CompoundType", + "label": "packageInfo", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L89" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L86" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PackageCustomExtension", + "type": "Interface", + "label": "PackageCustomExtension", + "description": [ + "Extension point registration contract for Integration details Custom view" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.PackageCustomExtension.package", + "type": "string", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L94" + } + }, + { + "tags": [], + "id": "def-public.PackageCustomExtension.view", + "type": "string", + "label": "view", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L95" + }, + "signature": [ + "\"package-detail-custom\"" + ] + }, + { + "tags": [], + "id": "def-public.PackageCustomExtension.component", + "type": "Function", + "label": "component", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L96" + }, + "signature": [ + "React.LazyExoticComponent>" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L93" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.AnyIntraAppRouteState", + "type": "Type", + "label": "AnyIntraAppRouteState", + "tags": [], + "description": [ + "\nAll possible Route states." + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L44" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.CreatePackagePolicyRouteState", + "text": "CreatePackagePolicyRouteState" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.AgentPolicyDetailsDeployAgentAction", + "text": "AgentPolicyDetailsDeployAgentAction" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.AgentDetailsReassignPolicyAction", + "text": "AgentDetailsReassignPolicyAction" + } + ], + "initialIsOpen": false + }, + { + "id": "def-public.UIExtensionRegistrationCallback", + "type": "Type", + "label": "UIExtensionRegistrationCallback", + "tags": [], + "description": [ + "Register a Fleet UI extension" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L12" + }, + "signature": [ + "(extensionPoint: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.UIExtensionPoint", + "text": "UIExtensionPoint" + }, + ") => void" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyEditExtensionComponent", + "type": "Type", + "label": "PackagePolicyEditExtensionComponent", + "tags": [], + "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": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L23" + }, + "signature": [ + "React.ComponentClass<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtensionComponentProps", + "text": "PackagePolicyEditExtensionComponentProps" + }, + ", any> | React.FunctionComponent<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtensionComponentProps", + "text": "PackagePolicyEditExtensionComponentProps" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PackagePolicyCreateExtensionComponent", + "type": "Type", + "label": "PackagePolicyCreateExtensionComponent", + "tags": [], + "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": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L57" + }, + "signature": [ + "React.ComponentClass<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtensionComponentProps", + "text": "PackagePolicyCreateExtensionComponentProps" + }, + ", any> | React.FunctionComponent<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtensionComponentProps", + "text": "PackagePolicyCreateExtensionComponentProps" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PackageCustomExtensionComponent", + "type": "Type", + "label": "PackageCustomExtensionComponent", + "tags": [], + "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": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L84" + }, + "signature": [ + "React.ComponentClass<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtensionComponentProps", + "text": "PackageCustomExtensionComponentProps" + }, + ", any> | React.FunctionComponent<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtensionComponentProps", + "text": "PackageCustomExtensionComponentProps" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-public.UIExtensionPoint", + "type": "Type", + "label": "UIExtensionPoint", + "tags": [], + "description": [ + "Fleet UI Extension Point" + ], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L100" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtension", + "text": "PackagePolicyEditExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtension", + "text": "PackageCustomExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtension", + "text": "PackagePolicyCreateExtension" + } + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.pagePathGetters", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-public.pagePathGetters.base", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "base", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L75" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.overview", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "overview", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L76" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integrations", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "integrations", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L77" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integrations_all", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "integrations_all", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L78" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integrations_installed", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "integrations_installed", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L79" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integration_details_overview", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ pkgkey }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L80" + } + } + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "integration_details_overview", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L80" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integration_details_policies", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ pkgkey }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L81" + } + } + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "integration_details_policies", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L81" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integration_details_settings", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ pkgkey }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L82" + } + } + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "integration_details_settings", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L82" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integration_details_custom", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ pkgkey }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L83" + } + } + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "integration_details_custom", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L83" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.integration_policy_edit", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ packagePolicyId }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L84" + } + } + ], + "signature": [ + "({ packagePolicyId }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "integration_policy_edit", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L84" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.policies", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "policies", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L86" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.policies_list", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "policies_list", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L87" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.policy_details", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ policyId, tabId }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L88" + } + } + ], + "signature": [ + "({ policyId, tabId }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "policy_details", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L88" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.add_integration_from_policy", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ policyId }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L89" + } + } + ], + "signature": [ + "({ policyId }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "add_integration_from_policy", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L89" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.add_integration_to_policy", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ pkgkey }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L90" + } + } + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "add_integration_to_policy", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L90" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.edit_integration", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ policyId, packagePolicyId }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L91" + } + } + ], + "signature": [ + "({ policyId, packagePolicyId }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "edit_integration", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L91" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.fleet", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "fleet", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L93" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.fleet_agent_list", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ kuery }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L94" + } + } + ], + "signature": [ + "({ kuery }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "fleet_agent_list", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L94" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.fleet_agent_details", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "{ agentId, tabId, logQuery }", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L95" + } + } + ], + "signature": [ + "({ agentId, tabId, logQuery }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => string" + ], + "description": [], + "label": "fleet_agent_details", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L95" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.fleet_enrollment_tokens", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "fleet_enrollment_tokens", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L97" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.pagePathGetters.data_streams", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "data_streams", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L98" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "pagePathGetters", + "source": { + "path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L69" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-public.FleetSetup", + "type": "Interface", + "label": "FleetSetup", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L47" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.FleetStart", + "type": "Interface", + "label": "FleetStart", + "description": [ + "\nDescribes public Fleet plugin contract returned at the `start` stage." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FleetStart.registerExtension", + "type": "Function", + "label": "registerExtension", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L53" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.UIExtensionRegistrationCallback", + "text": "UIExtensionRegistrationCallback" + } + ] + }, + { + "tags": [], + "id": "def-public.FleetStart.isInitialized", + "type": "Function", + "label": "isInitialized", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L54" + }, + "signature": [ + "() => Promise" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/public/plugin.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L52" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [ + { + "id": "def-server.getRegistryUrl", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getRegistryUrl", + "source": { + "path": "x-pack/plugins/fleet/server/services/epm/registry/registry_url.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/epm/registry/registry_url.ts#L33" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-server.AgentService", + "type": "Interface", + "label": "AgentService", + "description": [ + "\nA service that provides exported functions that return information about an Agent" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AgentService.getAgent", + "type": "Function", + "label": "getAgent", + "description": [ + "\nGet an Agent by id" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L47" + }, + "signature": [ + "typeof ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.getAgent", + "text": "getAgent" + } + ] + }, + { + "id": "def-server.AgentService.authenticateAgentWithAccessToken", + "type": "Function", + "label": "authenticateAgentWithAccessToken", + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + ">" + ], + "description": [ + "\nAuthenticate an agent with access toekn" + ], + "children": [ + { + "type": "Object", + "label": "soClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L52" + } + }, + { + "type": "CompoundType", + "label": "esClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L53" + } + }, + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L54" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L51" + } + }, + { + "id": "def-server.AgentService.getAgentStatusById", + "type": "Function", + "label": "getAgentStatusById", + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", agentId: string) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentStatus", + "text": "AgentStatus" + }, + ">" + ], + "description": [ + "\nReturn the status by the Agent's id" + ], + "children": [ + { + "type": "Object", + "label": "soClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L60" + } + }, + { + "type": "CompoundType", + "label": "esClient", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L61" + } + }, + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L62" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L59" + } + }, + { + "tags": [], + "id": "def-server.AgentService.listAgents", + "type": "Function", + "label": "listAgents", + "description": [ + "\nList agents" + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L67" + }, + "signature": [ + "typeof ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.listAgents", + "text": "listAgents" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ESIndexPatternService", + "type": "Interface", + "label": "ESIndexPatternService", + "description": [ + "\nService to return the index pattern of EPM packages" + ], + "tags": [], + "children": [ + { + "id": "def-server.ESIndexPatternService.getESIndexPattern", + "type": "Function", + "label": "getESIndexPattern", + "signature": [ + "(savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, pkgName: string, datasetPath: string) => Promise" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "savedObjectsClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L23" + } + }, + { + "type": "string", + "label": "pkgName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L24" + } + }, + { + "type": "string", + "label": "datasetPath", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L22" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-server.PackageService", + "type": "Interface", + "label": "PackageService", + "description": [ + "\nService that provides exported function that return information about EPM packages" + ], + "tags": [], + "children": [ + { + "id": "def-server.PackageService.getInstalledEsAssetReferences", + "type": "Function", + "label": "getInstalledEsAssetReferences", + "signature": [ + "(savedObjectsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, pkgName: string) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EsAssetReference", + "text": "EsAssetReference" + }, + "[]>" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "savedObjectsClient", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L35" + } + }, + { + "type": "string", + "label": "pkgName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L36" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L34" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L33" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AgentPolicyServiceInterface", + "type": "Interface", + "label": "AgentPolicyServiceInterface", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AgentPolicyServiceInterface.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L71" + }, + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, id: string, withPackagePolicies?: boolean) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + " | null>" + ] + }, + { + "tags": [], + "id": "def-server.AgentPolicyServiceInterface.list", + "type": "Function", + "label": "list", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L72" + }, + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + "[]; total: number; page: number; perPage: number; }>" + ] + }, + { + "tags": [], + "id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId", + "type": "Function", + "label": "getDefaultAgentPolicyId", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L73" + }, + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Promise" + ] + }, + { + "tags": [], + "id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy", + "type": "Function", + "label": "getFullAgentPolicy", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L74" + }, + "signature": [ + "(soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + }, + " | null>" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/services/index.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L70" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FleetSetupDeps", + "type": "Interface", + "label": "FleetSetupDeps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FleetSetupDeps.licensing", + "type": "Object", + "label": "licensing", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L89" + }, + "signature": [ + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginSetup", + "text": "LicensingPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetSetupDeps.security", + "type": "Object", + "label": "security", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L90" + }, + "signature": [ + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.SecurityPluginSetup", + "text": "SecurityPluginSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FleetSetupDeps.features", + "type": "Object", + "label": "features", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L91" + }, + "signature": [ + { + "pluginId": "features", + "scope": "server", + "docId": "kibFeaturesPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FleetSetupDeps.encryptedSavedObjects", + "type": "Object", + "label": "encryptedSavedObjects", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L92" + }, + "signature": [ + { + "pluginId": "encryptedSavedObjects", + "scope": "server", + "docId": "kibEncryptedSavedObjectsPluginApi", + "section": "def-server.EncryptedSavedObjectsPluginSetup", + "text": "EncryptedSavedObjectsPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetSetupDeps.cloud", + "type": "Object", + "label": "cloud", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L93" + }, + "signature": [ + { + "pluginId": "cloud", + "scope": "server", + "docId": "kibCloudPluginApi", + "section": "def-server.CloudSetup", + "text": "CloudSetup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.FleetSetupDeps.usageCollection", + "type": "Object", + "label": "usageCollection", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L94" + }, + "signature": [ + "Pick<", + { + "pluginId": "usageCollection", + "scope": "server", + "docId": "kibUsageCollectionPluginApi", + "section": "def-server.CollectorSet", + "text": "CollectorSet" + }, + ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L88" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.ExternalCallback", + "type": "Type", + "label": "ExternalCallback", + "tags": [], + "description": [ + "\nCallbacks supported by the Fleet plugin" + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L132" + }, + "signature": [ + "[\"packagePolicyCreate\", (newPackagePolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ", context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ">] | [\"packagePolicyUpdate\", (newPackagePolicy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + } + ], + "initialIsOpen": false + }, + { + "id": "def-server.FleetConfigType", + "type": "Type", + "label": "FleetConfigType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/index.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/index.ts#L73" + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-server.PackagePolicyServiceInterface", + "type": "Type", + "label": "PackagePolicyServiceInterface", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "lineNumber": 592, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/package_policy.ts#L592" + }, + "signature": [ + "PackagePolicyService" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], + "id": "def-server.agent", + "type": "Object", + "label": "agent", + "description": [], + "source": { + "path": "node_modules/elastic-apm-node/index.d.ts", + "lineNumber": 7, + "link": "https://github.com/elastic/kibana/tree/masternode_modules/elastic-apm-node/index.d.ts#L7" + }, + "signature": [ + "Agent" + ], + "initialIsOpen": false + } + ], + "setup": { + "id": "def-server.FleetSetupContract", + "type": "Type", + "label": "FleetSetupContract", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L117" + }, + "signature": [ + "void" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.FleetStartContract", + "type": "Interface", + "label": "FleetStartContract", + "description": [ + "\nDescribes public Fleet plugin contract returned at the `startup` stage." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FleetStartContract.esIndexPatternService", + "type": "Object", + "label": "esIndexPatternService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L156" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.ESIndexPatternService", + "text": "ESIndexPatternService" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetStartContract.packageService", + "type": "Object", + "label": "packageService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L157" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.PackageService", + "text": "PackageService" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetStartContract.agentService", + "type": "Object", + "label": "agentService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L158" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.AgentService", + "text": "AgentService" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetStartContract.packagePolicyService", + "type": "Object", + "label": "packagePolicyService", + "description": [ + "\nServices for Fleet's package policies" + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L162" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.PackagePolicyService", + "text": "PackagePolicyService" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetStartContract.agentPolicyService", + "type": "Object", + "label": "agentPolicyService", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 163, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L163" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.AgentPolicyServiceInterface", + "text": "AgentPolicyServiceInterface" + } + ] + }, + { + "tags": [], + "id": "def-server.FleetStartContract.registerExternalCallback", + "type": "Function", + "label": "registerExternalCallback", + "description": [ + "\nRegister callbacks for inclusion in fleet API processing" + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L168" + }, + "signature": [ + "(...args: ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.ExternalCallback", + "text": "ExternalCallback" + }, + ") => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/server/plugin.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L155" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "id": "def-common.LicenseService", + "type": "Class", + "tags": [], + "label": "LicenseService", + "description": [], + "children": [ + { + "id": "def-common.LicenseService.start", + "type": "Function", + "label": "start", + "signature": [ + "(license$: ", + "Observable", + "<", + { + "pluginId": "licensing", + "scope": "common", + "docId": "kibLicensingPluginApi", + "section": "def-common.ILicense", + "text": "ILicense" + }, + ">) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "license$", + "isRequired": true, + "signature": [ + "Observable", + "<", + { + "pluginId": "licensing", + "scope": "common", + "docId": "kibLicensingPluginApi", + "section": "def-common.ILicense", + "text": "ILicense" + }, + ">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L22" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L22" + } + }, + { + "id": "def-common.LicenseService.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L27" + } + }, + { + "id": "def-common.LicenseService.getLicenseInformation", + "type": "Function", + "label": "getLicenseInformation", + "signature": [ + "() => ", + { + "pluginId": "licensing", + "scope": "common", + "docId": "kibLicensingPluginApi", + "section": "def-common.ILicense", + "text": "ILicense" + }, + " | null" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L33" + } + }, + { + "id": "def-common.LicenseService.getLicenseInformation$", + "type": "Function", + "label": "getLicenseInformation$", + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "licensing", + "scope": "common", + "docId": "kibLicensingPluginApi", + "section": "def-common.ILicense", + "text": "ILicense" + }, + "> | null" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L37" + } + }, + { + "id": "def-common.LicenseService.isGoldPlus", + "type": "Function", + "label": "isGoldPlus", + "signature": [ + "() => boolean | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L41" + } + }, + { + "id": "def-common.LicenseService.isEnterprise", + "type": "Function", + "label": "isEnterprise", + "signature": [ + "() => boolean | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L48" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/services/license.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L13" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.packageToPackagePolicyInputs", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "packageInfo", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L47" + } + } + ], + "signature": [ + "(packageInfo: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + }, + ") => ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[]" + ], + "description": [], + "label": "packageToPackagePolicyInputs", + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L46" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.packageToPackagePolicy", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "packageInfo", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L117" + } + }, + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L118" + } + }, + { + "type": "string", + "label": "outputId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L119" + } + }, + { + "type": "string", + "label": "namespace", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L120" + } + }, + { + "type": "string", + "label": "packagePolicyName", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L121" + } + }, + { + "type": "string", + "label": "description", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L122" + } + } + ], + "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" + } + ], + "description": [ + "\nBuilds a `NewPackagePolicy` structure based on a package\n" + ], + "label": "packageToPackagePolicy", + "source": { + "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L116" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.storedPackagePoliciesToAgentInputs", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "packagePolicies", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + "[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts#L12" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.fullAgentPolicyToYaml", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "policy", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts#L26" + } + } + ], + "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": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isPackageLimited", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "packageInfo", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L11" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L11" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.doesAgentPolicyAlreadyIncludePackage", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "agentPolicy", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L16" + } + }, + { + "type": "string", + "label": "packageName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L17" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L15" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.decodeCloudId", + "type": "Function", + "label": "decodeCloudId", + "signature": [ + "(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "cid", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/decode_cloud_id.ts#L10" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/decode_cloud_id.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isValidNamespace", + "type": "Function", + "label": "isValidNamespace", + "signature": [ + "(namespace: string) => { valid: boolean; error?: string | undefined; }" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_valid_namespace.ts#L13" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_valid_namespace.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isDiffPathProtocol", + "type": "Function", + "label": "isDiffPathProtocol", + "signature": [ + "(kibanaUrls: string[]) => boolean" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "kibanaUrls", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_diff_path_protocol.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_diff_path_protocol.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-common.isAgentUpgradeable", + "type": "Function", + "label": "isAgentUpgradeable", + "signature": [ + "(agent: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + ", kibanaVersion: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "agent", + "isRequired": true, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12" + } + }, + { + "type": "string", + "label": "kibanaVersion", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.entries", + "type": "Function", + "label": "entries", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L39" + }, + "signature": [ + "(o: T) => [keyof T, T[keyof T]][]" + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.FleetConfigType", + "type": "Interface", + "label": "FleetConfigType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetConfigType.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.FleetConfigType.registryUrl", + "type": "string", + "label": "registryUrl", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L13" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetConfigType.registryProxyUrl", + "type": "string", + "label": "registryProxyUrl", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetConfigType.agents", + "type": "Object", + "label": "agents", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L15" + }, + "signature": [ + "{ fleetServerEnabled: boolean; 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; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewAgentAction", + "type": "Interface", + "label": "NewAgentAction", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewAgentAction.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L38" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } + ] + }, + { + "tags": [], + "id": "def-common.NewAgentAction.data", + "type": "Any", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L39" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.NewAgentAction.sent_at", + "type": "string", + "label": "sent_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L40" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentAction", + "type": "Interface", + "label": "AgentAction", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentAction", + "text": "AgentAction" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentAction", + "text": "NewAgentAction" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AgentAction.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L44" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } + ] + }, + { + "tags": [], + "id": "def-common.AgentAction.data", + "type": "Any", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L45" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.AgentAction.sent_at", + "type": "string", + "label": "sent_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L46" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AgentAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L47" + } + }, + { + "tags": [], + "id": "def-common.AgentAction.agent_id", + "type": "string", + "label": "agent_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L48" + } + }, + { + "tags": [], + "id": "def-common.AgentAction.created_at", + "type": "string", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L49" + } + }, + { + "tags": [], + "id": "def-common.AgentAction.ack_data", + "type": "Any", + "label": "ack_data", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L50" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicyAction", + "type": "Interface", + "label": "AgentPolicyAction", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicyAction", + "text": "AgentPolicyAction" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentAction", + "text": "NewAgentAction" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AgentPolicyAction.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L55" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionType", + "text": "AgentActionType" + } + ] + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.data", + "type": "Object", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L56" + }, + "signature": [ + "{ policy: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.policy_id", + "type": "string", + "label": "policy_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L59" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.policy_revision", + "type": "number", + "label": "policy_revision", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L60" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.created_at", + "type": "string", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L61" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicyAction.ack_data", + "type": "Any", + "label": "ack_data", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L62" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L53" + }, + "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": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L93" + }, + "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": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L94" + }, + "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": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L109" + } + }, + { + "tags": [], + "id": "def-common.NewAgentEvent.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L110" + } + }, + { + "tags": [], + "id": "def-common.NewAgentEvent.payload", + "type": "Any", + "label": "payload", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L111" + }, + "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": 112, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L112" + } + }, + { + "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": 113, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L113" + }, + "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": 114, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L114" + }, + "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": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L115" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L92" + }, + "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": 119, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L119" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L118" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentMetadata", + "type": "Interface", + "label": "AgentMetadata", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.AgentMetadata.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L125" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L124" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Agent", + "type": "Interface", + "label": "Agent", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + " extends AgentBase" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Agent.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L147" + } + }, + { + "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": 148, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L148" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentEvent", + "text": "AgentEvent" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.Agent.access_api_key", + "type": "string", + "label": "access_api_key", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 149, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L149" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Agent.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L150" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Agent.packages", + "type": "Array", + "label": "packages", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L151" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L146" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentSOAttributes", + "type": "Interface", + "label": "AgentSOAttributes", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentSOAttributes", + "text": "AgentSOAttributes" + }, + " extends AgentBase" + ], + "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": 155, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L155" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AgentSOAttributes.packages", + "type": "Array", + "label": "packages", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L156" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L154" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FleetServerAgent", + "type": "Interface", + "label": "FleetServerAgent", + "description": [ + "\nAn Elastic Agent that has enrolled into Fleet" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetServerAgent._version", + "type": "number", + "label": "_version", + "description": [ + "\nThe version of the document in the index" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L168" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.shared_id", + "type": "string", + "label": "shared_id", + "description": [ + "\nShared ID" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L172" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.type", + "type": "CompoundType", + "label": "type", + "description": [ + "\nType" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L176" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentType", + "text": "AgentType" + } + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.active", + "type": "boolean", + "label": "active", + "description": [ + "\nActive flag" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L180" + } + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.enrolled_at", + "type": "string", + "label": "enrolled_at", + "description": [ + "\nDate/time the Elastic Agent enrolled" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L184" + } + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.unenrolled_at", + "type": "string", + "label": "unenrolled_at", + "description": [ + "\nDate/time the Elastic Agent unenrolled" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L188" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.unenrollment_started_at", + "type": "string", + "label": "unenrollment_started_at", + "description": [ + "\nDate/time the Elastic Agent unenrolled started" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L192" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.upgraded_at", + "type": "CompoundType", + "label": "upgraded_at", + "description": [ + "\nDate/time the Elastic Agent was last upgraded" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L196" + }, + "signature": [ + "string | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.upgrade_started_at", + "type": "CompoundType", + "label": "upgrade_started_at", + "description": [ + "\nDate/time the Elastic Agent started the current upgrade" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L200" + }, + "signature": [ + "string | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.access_api_key_id", + "type": "string", + "label": "access_api_key_id", + "description": [ + "\nID of the API key the Elastic Agent must used to contact Fleet Server" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L204" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.agent", + "type": "Object", + "label": "agent", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L205" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FleetServerAgentMetadata", + "text": "FleetServerAgentMetadata" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.user_provided_metadata", + "type": "Object", + "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": 209, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L209" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentMetadata", + "text": "AgentMetadata" + } + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.local_metadata", + "type": "Object", + "label": "local_metadata", + "description": [ + "\nLocal metadata information for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L213" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentMetadata", + "text": "AgentMetadata" + } + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.policy_id", + "type": "string", + "label": "policy_id", + "description": [ + "\nThe policy ID for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L217" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.policy_revision_idx", + "type": "CompoundType", + "label": "policy_revision_idx", + "description": [ + "\nThe current policy revision_idx for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L221" + }, + "signature": [ + "number | null | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.policy_coordinator_idx", + "type": "number", + "label": "policy_coordinator_idx", + "description": [ + "\nThe current policy coordinator for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L225" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.last_updated", + "type": "string", + "label": "last_updated", + "description": [ + "\nDate/time the Elastic Agent was last updated" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L229" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.last_checkin", + "type": "string", + "label": "last_checkin", + "description": [ + "\nDate/time the Elastic Agent checked in last time" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 233, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L233" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.last_checkin_status", + "type": "CompoundType", + "label": "last_checkin_status", + "description": [ + "\nLst checkin status" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L237" + }, + "signature": [ + "\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.default_api_key_id", + "type": "string", + "label": "default_api_key_id", + "description": [ + "\nID of the API key the Elastic Agent uses to authenticate with elasticsearch" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L241" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.default_api_key", + "type": "string", + "label": "default_api_key", + "description": [ + "\nAPI key the Elastic Agent uses to authenticate with elasticsearch" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L245" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.updated_at", + "type": "string", + "label": "updated_at", + "description": [ + "\nDate/time the Elastic Agent was last updated" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 249, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L249" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.packages", + "type": "Array", + "label": "packages", + "description": [ + "\nPackages array" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L253" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgent.action_seq_no", + "type": "number", + "label": "action_seq_no", + "description": [ + "\nThe last acknowledged action sequence number for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L257" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L164" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FleetServerAgentMetadata", + "type": "Interface", + "label": "FleetServerAgentMetadata", + "description": [ + "\nAn Elastic Agent metadata" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetServerAgentMetadata.id", + "type": "string", + "label": "id", + "description": [ + "\nThe unique identifier for the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L266" + } + }, + { + "tags": [], + "id": "def-common.FleetServerAgentMetadata.version", + "type": "string", + "label": "version", + "description": [ + "\nThe version of the Elastic Agent" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L270" + } + }, + { + "id": "def-common.FleetServerAgentMetadata.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 271, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L271" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L262" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FleetServerAgentAction", + "type": "Interface", + "label": "FleetServerAgentAction", + "description": [ + "\nAn Elastic Agent action" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetServerAgentAction._id", + "type": "string", + "label": "_id", + "description": [ + "\nThe unique identifier for action document" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L281" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction._seq_no", + "type": "number", + "label": "_seq_no", + "description": [ + "\nThe action sequence number" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L285" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.action_id", + "type": "string", + "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." + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L289" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.'@timestamp'", + "type": "string", + "label": "'@timestamp'", + "description": [ + "\nDate/time the action was created" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L293" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.expiration", + "type": "string", + "label": "expiration", + "description": [ + "\nThe action expiration date/time" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L297" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.type", + "type": "string", + "label": "type", + "description": [ + "\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats." + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L301" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.input_id", + "type": "string", + "label": "input_id", + "description": [ + "\nThe input identifier the actions should be routed to." + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 305, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L305" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.agents", + "type": "Array", + "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" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 309, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L309" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerAgentAction.data", + "type": "Object", + "label": "data", + "description": [ + "\nThe opaque payload." + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L313" + }, + "signature": [ + "{ [k: string]: unknown; } | undefined" + ] + }, + { + "id": "def-common.FleetServerAgentAction.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 316, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L316" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L277" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewAgentPolicy", + "type": "Interface", + "label": "NewAgentPolicy", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewAgentPolicy.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.is_default", + "type": "CompoundType", + "label": "is_default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L19" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.is_default_fleet_server", + "type": "CompoundType", + "label": "is_default_fleet_server", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L20" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.is_managed", + "type": "CompoundType", + "label": "is_managed", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L21" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewAgentPolicy.monitoring_enabled", + "type": "Array", + "label": "monitoring_enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L22" + }, + "signature": [ + "(\"metrics\" | \"logs\")[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicy", + "type": "Interface", + "label": "AgentPolicy", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AgentPolicy.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L26" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicy.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L27" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ValueOf", + "text": "ValueOf" + }, + "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>" + ] + }, + { + "tags": [], + "id": "def-common.AgentPolicy.package_policies", + "type": "CompoundType", + "label": "package_policies", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L28" + }, + "signature": [ + "string[] | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.AgentPolicy.is_managed", + "type": "boolean", + "label": "is_managed", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L29" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicy.updated_at", + "type": "string", + "label": "updated_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicy.updated_by", + "type": "string", + "label": "updated_by", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.AgentPolicy.revision", + "type": "number", + "label": "revision", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L32" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FullAgentPolicyInputStream", + "type": "Interface", + "label": "FullAgentPolicyInputStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FullAgentPolicyInputStream.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L38" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInputStream.data_stream", + "type": "Object", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L39" + }, + "signature": [ + "{ dataset: string; type: string; }" + ] + }, + { + "id": "def-common.FullAgentPolicyInputStream.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L43" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FullAgentPolicyInput", + "type": "Interface", + "label": "FullAgentPolicyInput", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L47" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L48" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.revision", + "type": "number", + "label": "revision", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L49" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L50" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.data_stream", + "type": "Object", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L51" + }, + "signature": [ + "{ namespace: string; }" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.use_output", + "type": "string", + "label": "use_output", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L52" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L53" + }, + "signature": [ + "{ [key: string]: unknown; package?: Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + ", \"name\" | \"version\"> | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyInput.streams", + "type": "Array", + "label": "streams", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L57" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyInputStream", + "text": "FullAgentPolicyInputStream" + }, + "[] | undefined" + ] + }, + { + "id": "def-common.FullAgentPolicyInput.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L58" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FullAgentPolicy", + "type": "Interface", + "label": "FullAgentPolicy", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FullAgentPolicy.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L62" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.outputs", + "type": "Object", + "label": "outputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L63" + }, + "signature": [ + "{ [key: string]: Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Output", + "text": "Output" + }, + ", \"type\" | \"hosts\" | \"ca_sha256\" | \"api_key\"> & { [key: string]: any; }; }" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.fleet", + "type": "Object", + "label": "fleet", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L68" + }, + "signature": [ + "{ kibana: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyKibanaConfig", + "text": "FullAgentPolicyKibanaConfig" + }, + "; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.inputs", + "type": "Array", + "label": "inputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L71" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyInput", + "text": "FullAgentPolicyInput" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.revision", + "type": "number", + "label": "revision", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L72" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicy.agent", + "type": "Object", + "label": "agent", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L73" + }, + "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": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L61" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FullAgentPolicyKibanaConfig", + "type": "Interface", + "label": "FullAgentPolicyKibanaConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FullAgentPolicyKibanaConfig.hosts", + "type": "Array", + "label": "hosts", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L84" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyKibanaConfig.protocol", + "type": "string", + "label": "protocol", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L85" + } + }, + { + "tags": [], + "id": "def-common.FullAgentPolicyKibanaConfig.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L86" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L83" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FleetServerPolicy", + "type": "Interface", + "label": "FleetServerPolicy", + "description": [ + "\nA policy that an Elastic Agent is attached to" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetServerPolicy.'@timestamp'", + "type": "string", + "label": "'@timestamp'", + "description": [ + "\nDate/time the policy revision was created" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L98" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerPolicy.policy_id", + "type": "string", + "label": "policy_id", + "description": [ + "\nThe ID of the policy" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L102" + } + }, + { + "tags": [], + "id": "def-common.FleetServerPolicy.revision_idx", + "type": "number", + "label": "revision_idx", + "description": [ + "\nThe revision index of the policy" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L106" + } + }, + { + "tags": [], + "id": "def-common.FleetServerPolicy.coordinator_idx", + "type": "number", + "label": "coordinator_idx", + "description": [ + "\nThe coordinator index of the policy" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L110" + } + }, + { + "tags": [], + "id": "def-common.FleetServerPolicy.data", + "type": "Object", + "label": "data", + "description": [ + "\nThe opaque payload." + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L114" + }, + "signature": [ + "{ [k: string]: unknown; }" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerPolicy.default_fleet_server", + "type": "boolean", + "label": "default_fleet_server", + "description": [ + "\nTrue when this policy is the default policy to start Fleet Server" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L120" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L94" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicyPackage", + "type": "Interface", + "label": "PackagePolicyPackage", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackagePolicyPackage.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L9" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicyPackage.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicyPackage.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L11" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicyConfigRecordEntry", + "type": "Interface", + "label": "PackagePolicyConfigRecordEntry", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackagePolicyConfigRecordEntry.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L15" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackagePolicyConfigRecordEntry.value", + "type": "Any", + "label": "value", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L16" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewPackagePolicyInputStream", + "type": "Interface", + "label": "NewPackagePolicyInputStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewPackagePolicyInputStream.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInputStream.data_stream", + "type": "Object", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L23" + }, + "signature": [ + "{ dataset: string; type: string; }" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInputStream.vars", + "type": "Object", + "label": "vars", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L27" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInputStream.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L28" + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicyInputStream", + "type": "Interface", + "label": "PackagePolicyInputStream", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInputStream", + "text": "PackagePolicyInputStream" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInputStream", + "text": "NewPackagePolicyInputStream" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackagePolicyInputStream.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L32" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicyInputStream.compiled_stream", + "type": "Any", + "label": "compiled_stream", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L33" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewPackagePolicyInput", + "type": "Interface", + "label": "NewPackagePolicyInput", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewPackagePolicyInput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInput.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L38" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInput.vars", + "type": "Object", + "label": "vars", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L39" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInput.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L40" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicyInput.streams", + "type": "Array", + "label": "streams", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L41" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInputStream", + "text": "NewPackagePolicyInputStream" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicyInput", + "type": "Interface", + "label": "PackagePolicyInput", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInput", + "text": "PackagePolicyInput" + }, + " extends Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + ", \"type\" | \"enabled\" | \"config\" | \"vars\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackagePolicyInput.streams", + "type": "Array", + "label": "streams", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L45" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInputStream", + "text": "PackagePolicyInputStream" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.PackagePolicyInput.compiled_input", + "type": "Any", + "label": "compiled_input", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L46" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewPackagePolicy", + "type": "Interface", + "label": "NewPackagePolicy", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewPackagePolicy.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L50" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L51" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L52" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L53" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.policy_id", + "type": "string", + "label": "policy_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.output_id", + "type": "string", + "label": "output_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L55" + } + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.package", + "type": "Object", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L56" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewPackagePolicy.inputs", + "type": "Array", + "label": "inputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L57" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-common.UpdatePackagePolicy", + "type": "Interface", + "label": "UpdatePackagePolicy", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UpdatePackagePolicy.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L61" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicy", + "type": "Interface", + "label": "PackagePolicy", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + " extends Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + ", \"enabled\" | \"description\" | \"name\" | \"package\" | \"namespace\" | \"policy_id\" | \"output_id\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackagePolicy.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L65" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicy.inputs", + "type": "Array", + "label": "inputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L66" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInput", + "text": "PackagePolicyInput" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.PackagePolicy.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L67" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackagePolicy.revision", + "type": "number", + "label": "revision", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L68" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicy.updated_at", + "type": "string", + "label": "updated_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L69" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicy.updated_by", + "type": "string", + "label": "updated_by", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L70" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicy.created_at", + "type": "string", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L71" + } + }, + { + "tags": [], + "id": "def-common.PackagePolicy.created_by", + "type": "string", + "label": "created_by", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L72" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DataStream", + "type": "Interface", + "label": "DataStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataStream.index", + "type": "string", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L9" + } + }, + { + "tags": [], + "id": "def-common.DataStream.dataset", + "type": "string", + "label": "dataset", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.DataStream.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.DataStream.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.DataStream.package", + "type": "string", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.DataStream.package_version", + "type": "string", + "label": "package_version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.DataStream.last_activity_ms", + "type": "number", + "label": "last_activity_ms", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.DataStream.size_in_bytes", + "type": "number", + "label": "size_in_bytes", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.DataStream.dashboards", + "type": "Array", + "label": "dashboards", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L17" + }, + "signature": [ + "{ id: string; title: string; }[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.NewOutput", + "type": "Interface", + "label": "NewOutput", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.NewOutput.is_default", + "type": "boolean", + "label": "is_default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.NewOutput.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.NewOutput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L16" + }, + "signature": [ + "\"elasticsearch\"" + ] + }, + { + "tags": [], + "id": "def-common.NewOutput.hosts", + "type": "Array", + "label": "hosts", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L17" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewOutput.ca_sha256", + "type": "string", + "label": "ca_sha256", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L18" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewOutput.api_key", + "type": "string", + "label": "api_key", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L19" + }, + "signature": [ + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L20" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L21" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewOutput.config", + "type": "Object", + "label": "config", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L22" + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.NewOutput.config_yaml", + "type": "string", + "label": "config_yaml", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L23" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryImage", + "type": "Interface", + "label": "RegistryImage", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryImage.src", + "type": "string", + "label": "src", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L111" + } + }, + { + "tags": [], + "id": "def-common.RegistryImage.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L112" + } + }, + { + "tags": [], + "id": "def-common.RegistryImage.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L113" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryImage.size", + "type": "string", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L114" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryImage.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L115" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L110" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryPolicyTemplate", + "type": "Interface", + "label": "RegistryPolicyTemplate", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryPolicyTemplate.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L119" + } + }, + { + "tags": [], + "id": "def-common.RegistryPolicyTemplate.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L120" + } + }, + { + "tags": [], + "id": "def-common.RegistryPolicyTemplate.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L121" + } + }, + { + "tags": [], + "id": "def-common.RegistryPolicyTemplate.inputs", + "type": "Array", + "label": "inputs", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L122" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryInput", + "text": "RegistryInput" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryPolicyTemplate.multiple", + "type": "CompoundType", + "label": "multiple", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L123" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L118" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryInput", + "type": "Interface", + "label": "RegistryInput", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryInput.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L126" + } + }, + { + "tags": [], + "id": "def-common.RegistryInput.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L127" + } + }, + { + "tags": [], + "id": "def-common.RegistryInput.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L128" + } + }, + { + "tags": [], + "id": "def-common.RegistryInput.template_path", + "type": "string", + "label": "template_path", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L129" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryInput.condition", + "type": "string", + "label": "condition", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L130" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryInput.vars", + "type": "Array", + "label": "vars", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L131" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryVarsEntry", + "text": "RegistryVarsEntry" + }, + "[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L125" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryStream", + "type": "Interface", + "label": "RegistryStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryStream.input", + "type": "string", + "label": "input", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L134" + } + }, + { + "tags": [], + "id": "def-common.RegistryStream.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L135" + } + }, + { + "tags": [], + "id": "def-common.RegistryStream.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L136" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryStream.enabled", + "type": "CompoundType", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L137" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryStream.vars", + "type": "Array", + "label": "vars", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L138" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryVarsEntry", + "text": "RegistryVarsEntry" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryStream.template_path", + "type": "string", + "label": "template_path", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 139, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L139" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L133" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ServiceRequirements", + "type": "Interface", + "label": "ServiceRequirements", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ServiceRequirements.versions", + "type": "string", + "label": "versions", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L145" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L144" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CategorySummaryItem", + "type": "Interface", + "label": "CategorySummaryItem", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CategorySummaryItem.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 176, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L176" + } + }, + { + "tags": [], + "id": "def-common.CategorySummaryItem.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L177" + } + }, + { + "tags": [], + "id": "def-common.CategorySummaryItem.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L178" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 175, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L175" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AssetParts", + "type": "Interface", + "label": "AssetParts", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AssetParts.pkgkey", + "type": "string", + "label": "pkgkey", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 183, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L183" + } + }, + { + "tags": [], + "id": "def-common.AssetParts.dataset", + "type": "string", + "label": "dataset", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 184, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L184" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AssetParts.service", + "type": "CompoundType", + "label": "service", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L185" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ServiceName", + "text": "ServiceName" + } + ] + }, + { + "tags": [], + "id": "def-common.AssetParts.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L186" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetType", + "text": "AssetType" + } + ] + }, + { + "tags": [], + "id": "def-common.AssetParts.file", + "type": "string", + "label": "file", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L187" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L182" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryDataStream", + "type": "Interface", + "label": "RegistryDataStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryDataStream.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L213" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.ilm_policy", + "type": "string", + "label": "ilm_policy", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 214, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L214" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.hidden", + "type": "CompoundType", + "label": "hidden", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L215" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.dataset", + "type": "string", + "label": "dataset", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 216, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L216" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 217, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L217" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.release", + "type": "string", + "label": "release", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 218, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L218" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.streams", + "type": "Array", + "label": "streams", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 219, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L219" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryStream", + "text": "RegistryStream" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.package", + "type": "string", + "label": "package", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L220" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L221" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.ingest_pipeline", + "type": "string", + "label": "ingest_pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L222" + } + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.elasticsearch", + "type": "Object", + "label": "elasticsearch", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L223" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryElasticsearch", + "text": "RegistryElasticsearch" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryDataStream.dataset_is_prefix", + "type": "CompoundType", + "label": "dataset_is_prefix", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 224, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L224" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 212, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L212" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryElasticsearch", + "type": "Interface", + "label": "RegistryElasticsearch", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryElasticsearch.'index_template.settings'", + "type": "Uncategorized", + "label": "'index_template.settings'", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 228, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L228" + }, + "signature": [ + "object | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryElasticsearch.'index_template.mappings'", + "type": "Uncategorized", + "label": "'index_template.mappings'", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 229, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L229" + }, + "signature": [ + "object | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 227, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L227" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RegistryVarsEntry", + "type": "Interface", + "label": "RegistryVarsEntry", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RegistryVarsEntry.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L237" + } + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L238" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L239" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 240, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L240" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryVarType", + "text": "RegistryVarType" + } + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.required", + "type": "CompoundType", + "label": "required", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 241, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L241" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.show_user", + "type": "CompoundType", + "label": "show_user", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L242" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.multi", + "type": "CompoundType", + "label": "multi", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 243, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L243" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.default", + "type": "CompoundType", + "label": "default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 244, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L244" + }, + "signature": [ + "string | string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RegistryVarsEntry.os", + "type": "Object", + "label": "os", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 245, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L245" + }, + "signature": [ + "{ [key: string]: { default: string | string[]; }; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L236" + }, + "initialIsOpen": false + }, + { + "id": "def-common.EpmPackageAdditions", + "type": "Interface", + "label": "EpmPackageAdditions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EpmPackageAdditions.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L255" + } + }, + { + "tags": [], + "id": "def-common.EpmPackageAdditions.latestVersion", + "type": "string", + "label": "latestVersion", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L256" + } + }, + { + "tags": [], + "id": "def-common.EpmPackageAdditions.assets", + "type": "CompoundType", + "label": "assets", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L257" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetsGroupedByServiceByType", + "text": "AssetsGroupedByServiceByType" + } + ] + }, + { + "tags": [], + "id": "def-common.EpmPackageAdditions.removable", + "type": "CompoundType", + "label": "removable", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 258, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L258" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L254" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Installation", + "type": "Interface", + "label": "Installation", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" + }, + " extends ", + "SavedObjectAttributes" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Installation.installed_kibana", + "type": "Array", + "label": "installed_kibana", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 274, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L274" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetReference", + "text": "KibanaAssetReference" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.Installation.installed_es", + "type": "Array", + "label": "installed_es", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 275, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L275" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EsAssetReference", + "text": "EsAssetReference" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.Installation.package_assets", + "type": "Array", + "label": "package_assets", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 276, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L276" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageAssetReference", + "text": "PackageAssetReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.Installation.es_index_patterns", + "type": "Object", + "label": "es_index_patterns", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L277" + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-common.Installation.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 278, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L278" + } + }, + { + "tags": [], + "id": "def-common.Installation.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 279, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L279" + } + }, + { + "tags": [], + "id": "def-common.Installation.install_status", + "type": "CompoundType", + "label": "install_status", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 280, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L280" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EpmPackageInstallStatus", + "text": "EpmPackageInstallStatus" + } + ] + }, + { + "tags": [], + "id": "def-common.Installation.install_version", + "type": "string", + "label": "install_version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L281" + } + }, + { + "tags": [], + "id": "def-common.Installation.install_started_at", + "type": "string", + "label": "install_started_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L282" + } + }, + { + "tags": [], + "id": "def-common.Installation.install_source", + "type": "CompoundType", + "label": "install_source", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 283, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L283" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallSource", + "text": "InstallSource" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 273, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L273" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackageUsageStats", + "type": "Interface", + "label": "PackageUsageStats", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackageUsageStats.agent_policy_count", + "type": "number", + "label": "agent_policy_count", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 287, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L287" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L286" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexTemplateMappings", + "type": "Interface", + "label": "IndexTemplateMappings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexTemplateMappings.properties", + "type": "Any", + "label": "properties", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L319" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 318, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L318" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexTemplate", + "type": "Interface", + "label": "IndexTemplate", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexTemplate.priority", + "type": "number", + "label": "priority", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 326, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L326" + } + }, + { + "tags": [], + "id": "def-common.IndexTemplate.index_patterns", + "type": "Array", + "label": "index_patterns", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 327, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L327" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.IndexTemplate.template", + "type": "Object", + "label": "template", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 328, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L328" + }, + "signature": [ + "{ settings: any; mappings: any; }" + ] + }, + { + "tags": [], + "id": "def-common.IndexTemplate.data_stream", + "type": "Object", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 332, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L332" + }, + "signature": [ + "{ hidden?: boolean | undefined; }" + ] + }, + { + "tags": [], + "id": "def-common.IndexTemplate.composed_of", + "type": "Array", + "label": "composed_of", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 333, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L333" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.IndexTemplate._meta", + "type": "Uncategorized", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 334, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L334" + }, + "signature": [ + "object" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 325, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L325" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TemplateRef", + "type": "Interface", + "label": "TemplateRef", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TemplateRef.templateName", + "type": "string", + "label": "templateName", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 338, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L338" + } + }, + { + "tags": [], + "id": "def-common.TemplateRef.indexTemplate", + "type": "Object", + "label": "indexTemplate", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 339, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L339" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.IndexTemplate", + "text": "IndexTemplate" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 337, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L337" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackageSpecManifest", + "type": "Interface", + "label": "PackageSpecManifest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackageSpecManifest.format_version", + "type": "string", + "label": "format_version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L14" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L15" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L16" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.license", + "type": "string", + "label": "license", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L17" + }, + "signature": [ + "\"basic\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L18" + }, + "signature": [ + "\"integration\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.release", + "type": "CompoundType", + "label": "release", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L19" + }, + "signature": [ + "\"experimental\" | \"beta\" | \"ga\"" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.categories", + "type": "Array", + "label": "categories", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L20" + }, + "signature": [ + "(\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.conditions", + "type": "Object", + "label": "conditions", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L21" + }, + "signature": [ + "Record<\"kibana\", { version: string; }> | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.icons", + "type": "Array", + "label": "icons", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L22" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.screenshots", + "type": "Array", + "label": "screenshots", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L23" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecScreenshot", + "text": "PackageSpecScreenshot" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.policy_templates", + "type": "Array", + "label": "policy_templates", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L24" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPolicyTemplate", + "text": "RegistryPolicyTemplate" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecManifest.owner", + "type": "Object", + "label": "owner", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L25" + }, + "signature": [ + "{ github: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackageSpecIcon", + "type": "Interface", + "label": "PackageSpecIcon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackageSpecIcon.src", + "type": "string", + "label": "src", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L61" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecIcon.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L62" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecIcon.size", + "type": "string", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L63" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecIcon.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L64" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PackageSpecScreenshot", + "type": "Interface", + "label": "PackageSpecScreenshot", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PackageSpecScreenshot.src", + "type": "string", + "label": "src", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L68" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecScreenshot.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L69" + } + }, + { + "tags": [], + "id": "def-common.PackageSpecScreenshot.size", + "type": "string", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L70" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.PackageSpecScreenshot.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L71" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L67" + }, + "initialIsOpen": false + }, + { + "id": "def-common.EnrollmentAPIKey", + "type": "Interface", + "label": "EnrollmentAPIKey", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L9" + } + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.api_key_id", + "type": "string", + "label": "api_key_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L10" + } + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.api_key", + "type": "string", + "label": "api_key", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L12" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.active", + "type": "boolean", + "label": "active", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.policy_id", + "type": "string", + "label": "policy_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.EnrollmentAPIKey.created_at", + "type": "string", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L15" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.FleetServerEnrollmentAPIKey", + "type": "Interface", + "label": "FleetServerEnrollmentAPIKey", + "description": [ + "\nAn Elastic Agent enrollment API key" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.active", + "type": "CompoundType", + "label": "active", + "description": [ + "\nTrue when the key is active" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L29" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.api_key_id", + "type": "string", + "label": "api_key_id", + "description": [ + "\nThe unique identifier for the enrollment key, currently xid" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L33" + } + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.api_key", + "type": "string", + "label": "api_key", + "description": [ + "\nApi key" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.name", + "type": "string", + "label": "name", + "description": [ + "\nEnrollment key name" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L41" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.policy_id", + "type": "string", + "label": "policy_id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L42" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.expire_at", + "type": "string", + "label": "expire_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L43" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.created_at", + "type": "string", + "label": "created_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L44" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FleetServerEnrollmentAPIKey.updated_at", + "type": "string", + "label": "updated_at", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L45" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BaseSettings", + "type": "Interface", + "label": "BaseSettings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BaseSettings.agent_auto_upgrade", + "type": "boolean", + "label": "agent_auto_upgrade", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L11" + } + }, + { + "tags": [], + "id": "def-common.BaseSettings.package_auto_upgrade", + "type": "boolean", + "label": "package_auto_upgrade", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L12" + } + }, + { + "tags": [], + "id": "def-common.BaseSettings.kibana_urls", + "type": "Array", + "label": "kibana_urls", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L13" + }, + "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": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L14" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BaseSettings.has_seen_add_data_notice", + "type": "CompoundType", + "label": "has_seen_add_data_notice", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L15" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Settings", + "type": "Interface", + "label": "Settings", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Settings", + "text": "Settings" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.BaseSettings", + "text": "BaseSettings" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Settings.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L19" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SettingsSOAttributes", + "type": "Interface", + "label": "SettingsSOAttributes", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.SettingsSOAttributes", + "text": "SettingsSOAttributes" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.BaseSettings", + "text": "BaseSettings" + }, + ",", + "SavedObjectAttributes" + ], + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ListWithKuery", + "type": "Interface", + "label": "ListWithKuery", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListWithKuery", + "text": "ListWithKuery" + }, + " extends ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpFetchQuery", + "text": "HttpFetchQuery" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ListWithKuery.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L11" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ListWithKuery.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L12" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ListWithKuery.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L13" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ListWithKuery.sortOrder", + "type": "CompoundType", + "label": "sortOrder", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L14" + }, + "signature": [ + "\"asc\" | \"desc\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ListWithKuery.kuery", + "type": "string", + "label": "kuery", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L15" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ListResult", + "type": "Interface", + "label": "ListResult", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListResult", + "text": "ListResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ListResult.items", + "type": "Array", + "label": "items", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L19" + }, + "signature": [ + "T[]" + ] + }, + { + "tags": [], + "id": "def-common.ListResult.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.ListResult.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.ListResult.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L22" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetPackagePoliciesRequest", + "type": "Interface", + "label": "GetPackagePoliciesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetPackagePoliciesRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L11" + }, + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetPackagePoliciesResponse", + "type": "Interface", + "label": "GetPackagePoliciesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetPackagePoliciesResponse.items", + "type": "Array", + "label": "items", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L19" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.GetPackagePoliciesResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.GetPackagePoliciesResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.GetPackagePoliciesResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L22" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOnePackagePolicyRequest", + "type": "Interface", + "label": "GetOnePackagePolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOnePackagePolicyRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L26" + }, + "signature": [ + "{ packagePolicyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOnePackagePolicyResponse", + "type": "Interface", + "label": "GetOnePackagePolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOnePackagePolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L32" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CreatePackagePolicyRequest", + "type": "Interface", + "label": "CreatePackagePolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CreatePackagePolicyRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L36" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CreatePackagePolicyResponse", + "type": "Interface", + "label": "CreatePackagePolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CreatePackagePolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeletePackagePoliciesRequest", + "type": "Interface", + "label": "DeletePackagePoliciesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeletePackagePoliciesRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L50" + }, + "signature": [ + "{ packagePolicyIds: string[]; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetDataStreamsResponse", + "type": "Interface", + "label": "GetDataStreamsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetDataStreamsResponse.data_streams", + "type": "Array", + "label": "data_streams", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/data_stream.ts#L11" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.DataStream", + "text": "DataStream" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/data_stream.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentsRequest", + "type": "Interface", + "label": "GetAgentsRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentsRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L19" + }, + "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": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentsResponse", + "type": "Interface", + "label": "GetAgentsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentsResponse.list", + "type": "Array", + "label": "list", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L29" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.GetAgentsResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.GetAgentsResponse.totalInactive", + "type": "number", + "label": "totalInactive", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.GetAgentsResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L32" + } + }, + { + "tags": [], + "id": "def-common.GetAgentsResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L33" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L28" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneAgentRequest", + "type": "Interface", + "label": "GetOneAgentRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneAgentRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L37" + }, + "signature": [ + "{ agentId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneAgentResponse", + "type": "Interface", + "label": "GetOneAgentResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneAgentResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L43" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentCheckinRequest", + "type": "Interface", + "label": "PostAgentCheckinRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostAgentCheckinRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L47" + }, + "signature": [ + "{ agentId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.PostAgentCheckinRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L50" + }, + "signature": [ + "{ status?: \"online\" | \"error\" | \"degraded\" | undefined; local_metadata?: Record | undefined; events?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentEvent", + "text": "NewAgentEvent" + }, + "[] | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L46" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L58" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L60" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L57" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L64" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L63" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L74" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L76" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L73" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentAcksRequest", + "type": "Interface", + "label": "PostAgentAcksRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostAgentAcksRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L80" + }, + "signature": [ + "{ events: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentEvent", + "text": "AgentEvent" + }, + "[]; }" + ] + }, + { + "tags": [], + "id": "def-common.PostAgentAcksRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L83" + }, + "signature": [ + "{ agentId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L79" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentAcksResponse", + "type": "Interface", + "label": "PostAgentAcksResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostAgentAcksResponse.action", + "type": "string", + "label": "action", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L89" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostNewAgentActionRequest", + "type": "Interface", + "label": "PostNewAgentActionRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostNewAgentActionRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L93" + }, + "signature": [ + "{ action: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentAction", + "text": "NewAgentAction" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-common.PostNewAgentActionRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L96" + }, + "signature": [ + "{ agentId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L92" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostNewAgentActionResponse", + "type": "Interface", + "label": "PostNewAgentActionResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostNewAgentActionResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L102" + }, + "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": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L101" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentUnenrollRequest", + "type": "Interface", + "label": "PostAgentUnenrollRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostAgentUnenrollRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L106" + }, + "signature": [ + "{ agentId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.PostAgentUnenrollRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L109" + }, + "signature": [ + "{ force?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L105" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentUnenrollResponse", + "type": "Interface", + "label": "PostAgentUnenrollResponse", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L115" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUnenrollRequest", + "type": "Interface", + "label": "PostBulkAgentUnenrollRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostBulkAgentUnenrollRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L118" + }, + "signature": [ + "{ agents: string | string[]; force?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L117" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUnenrollResponse", + "type": "Interface", + "label": "PostBulkAgentUnenrollResponse", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L125" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentUpgradeRequest", + "type": "Interface", + "label": "PostAgentUpgradeRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostAgentUpgradeRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L128" + }, + "signature": [ + "{ agentId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.PostAgentUpgradeRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L131" + }, + "signature": [ + "{ source_uri?: string | undefined; version: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L127" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUpgradeRequest", + "type": "Interface", + "label": "PostBulkAgentUpgradeRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostBulkAgentUpgradeRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L138" + }, + "signature": [ + "{ agents: string | string[]; source_uri?: string | undefined; version: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L137" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentUpgradeResponse", + "type": "Interface", + "label": "PostBulkAgentUpgradeResponse", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 145, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L145" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostAgentUpgradeResponse", + "type": "Interface", + "label": "PostAgentUpgradeResponse", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 148, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L148" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutAgentReassignRequest", + "type": "Interface", + "label": "PutAgentReassignRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PutAgentReassignRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L151" + }, + "signature": [ + "{ agentId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.PutAgentReassignRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L154" + }, + "signature": [ + "{ policy_id: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 150, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L150" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutAgentReassignResponse", + "type": "Interface", + "label": "PutAgentReassignResponse", + "description": [], + "tags": [], + "children": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L158" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentReassignRequest", + "type": "Interface", + "label": "PostBulkAgentReassignRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostBulkAgentReassignRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L161" + }, + "signature": [ + "{ policy_id: string; agents: string | string[]; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L160" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostBulkAgentReassignResponse", + "type": "Interface", + "label": "PostBulkAgentReassignResponse", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.PostBulkAgentReassignResponse.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L168" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L167" + }, + "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": 175, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L175" + }, + "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": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L178" + }, + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L174" + }, + "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": 186, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L186" + }, + "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": 187, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L187" + } + }, + { + "tags": [], + "id": "def-common.GetOneAgentEventsResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L188" + } + }, + { + "tags": [], + "id": "def-common.GetOneAgentEventsResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L189" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 185, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L185" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteAgentRequest", + "type": "Interface", + "label": "DeleteAgentRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteAgentRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L193" + }, + "signature": [ + "{ agentId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L192" + }, + "initialIsOpen": false + }, + { + "id": "def-common.UpdateAgentRequest", + "type": "Interface", + "label": "UpdateAgentRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UpdateAgentRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 199, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L199" + }, + "signature": [ + "{ agentId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.UpdateAgentRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L202" + }, + "signature": [ + "{ user_provided_metadata: Record; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 198, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L198" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentStatusRequest", + "type": "Interface", + "label": "GetAgentStatusRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentStatusRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L208" + }, + "signature": [ + "{ kuery?: string | undefined; policyId?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L207" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentStatusResponse", + "type": "Interface", + "label": "GetAgentStatusResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentStatusResponse.results", + "type": "Object", + "label": "results", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L215" + }, + "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": 214, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L214" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentPoliciesRequest", + "type": "Interface", + "label": "GetAgentPoliciesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentPoliciesRequest.query", + "type": "CompoundType", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L12" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListWithKuery", + "text": "ListWithKuery" + }, + " & { full?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L11" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentPoliciesResponse", + "type": "Interface", + "label": "GetAgentPoliciesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetAgentPoliciesResponse.items", + "type": "Array", + "label": "items", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L20" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.GetAgentPoliciesResponseItem", + "text": "GetAgentPoliciesResponseItem" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.GetAgentPoliciesResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.GetAgentPoliciesResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.GetAgentPoliciesResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L23" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneAgentPolicyRequest", + "type": "Interface", + "label": "GetOneAgentPolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneAgentPolicyRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L27" + }, + "signature": [ + "{ agentPolicyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L26" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneAgentPolicyResponse", + "type": "Interface", + "label": "GetOneAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneAgentPolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L33" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CreateAgentPolicyRequest", + "type": "Interface", + "label": "CreateAgentPolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CreateAgentPolicyRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L37" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CreateAgentPolicyResponse", + "type": "Interface", + "label": "CreateAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CreateAgentPolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L41" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L40" + }, + "initialIsOpen": false + }, + { + "id": "def-common.UpdateAgentPolicyResponse", + "type": "Interface", + "label": "UpdateAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UpdateAgentPolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L49" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CopyAgentPolicyRequest", + "type": "Interface", + "label": "CopyAgentPolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CopyAgentPolicyRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L53" + }, + "signature": [ + "Pick<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + ", \"description\" | \"name\">" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CopyAgentPolicyResponse", + "type": "Interface", + "label": "CopyAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CopyAgentPolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L57" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteAgentPolicyRequest", + "type": "Interface", + "label": "DeleteAgentPolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteAgentPolicyRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L61" + }, + "signature": [ + "{ agentPolicyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L60" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteAgentPolicyResponse", + "type": "Interface", + "label": "DeleteAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteAgentPolicyResponse.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L67" + } + }, + { + "tags": [], + "id": "def-common.DeleteAgentPolicyResponse.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L68" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L66" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFullAgentPolicyRequest", + "type": "Interface", + "label": "GetFullAgentPolicyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFullAgentPolicyRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L72" + }, + "signature": [ + "{ agentPolicyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L71" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFullAgentPolicyResponse", + "type": "Interface", + "label": "GetFullAgentPolicyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFullAgentPolicyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L78" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CreateFleetSetupResponse", + "type": "Interface", + "label": "CreateFleetSetupResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CreateFleetSetupResponse.isInitialized", + "type": "boolean", + "label": "isInitialized", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L9" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFleetStatusResponse", + "type": "Interface", + "label": "GetFleetStatusResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFleetStatusResponse.isReady", + "type": "boolean", + "label": "isReady", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L13" + } + }, + { + "tags": [], + "id": "def-common.GetFleetStatusResponse.missing_requirements", + "type": "Array", + "label": "missing_requirements", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L14" + }, + "signature": [ + "(\"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": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetCategoriesRequest", + "type": "Interface", + "label": "GetCategoriesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetCategoriesRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L18" + }, + "signature": [ + "{ experimental?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetCategoriesResponse", + "type": "Interface", + "label": "GetCategoriesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetCategoriesResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L24" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.CategorySummaryList", + "text": "CategorySummaryList" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetPackagesRequest", + "type": "Interface", + "label": "GetPackagesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetPackagesRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L28" + }, + "signature": [ + "{ category?: string | undefined; experimental?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetPackagesResponse", + "type": "Interface", + "label": "GetPackagesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetPackagesResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L35" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installable", + "text": "Installable" + }, + ">[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetLimitedPackagesResponse", + "type": "Interface", + "label": "GetLimitedPackagesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetLimitedPackagesResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L39" + }, + "signature": [ + "string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L38" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetFileRequest", + "type": "Interface", + "label": "GetFileRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetFileRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L43" + }, + "signature": [ + "{ pkgkey: string; filePath: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetInfoRequest", + "type": "Interface", + "label": "GetInfoRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetInfoRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L50" + }, + "signature": [ + "{ pkgkey: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L49" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetInfoResponse", + "type": "Interface", + "label": "GetInfoResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetInfoResponse.response", + "type": "CompoundType", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L56" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L55" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetStatsRequest", + "type": "Interface", + "label": "GetStatsRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetStatsRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L60" + }, + "signature": [ + "{ pkgname: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L59" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetStatsResponse", + "type": "Interface", + "label": "GetStatsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetStatsResponse.response", + "type": "Object", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L66" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageUsageStats", + "text": "PackageUsageStats" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-common.InstallPackageRequest", + "type": "Interface", + "label": "InstallPackageRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.InstallPackageRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L70" + }, + "signature": [ + "{ pkgkey: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-common.InstallPackageResponse", + "type": "Interface", + "label": "InstallPackageResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.InstallPackageResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L76" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetReference", + "text": "AssetReference" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L75" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IBulkInstallPackageHTTPError", + "type": "Interface", + "label": "IBulkInstallPackageHTTPError", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IBulkInstallPackageHTTPError.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L80" + } + }, + { + "tags": [], + "id": "def-common.IBulkInstallPackageHTTPError.statusCode", + "type": "number", + "label": "statusCode", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L81" + } + }, + { + "tags": [], + "id": "def-common.IBulkInstallPackageHTTPError.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L82" + }, + "signature": [ + "string | Error" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L79" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BulkInstallPackageInfo", + "type": "Interface", + "label": "BulkInstallPackageInfo", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BulkInstallPackageInfo.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L86" + } + }, + { + "tags": [], + "id": "def-common.BulkInstallPackageInfo.newVersion", + "type": "string", + "label": "newVersion", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L87" + } + }, + { + "tags": [], + "id": "def-common.BulkInstallPackageInfo.oldVersion", + "type": "CompoundType", + "label": "oldVersion", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L89" + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.BulkInstallPackageInfo.assets", + "type": "Array", + "label": "assets", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L90" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetReference", + "text": "AssetReference" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L85" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BulkInstallPackagesResponse", + "type": "Interface", + "label": "BulkInstallPackagesResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BulkInstallPackagesResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L94" + }, + "signature": [ + "(", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.IBulkInstallPackageHTTPError", + "text": "IBulkInstallPackageHTTPError" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.BulkInstallPackageInfo", + "text": "BulkInstallPackageInfo" + }, + ")[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L93" + }, + "initialIsOpen": false + }, + { + "id": "def-common.BulkInstallPackagesRequest", + "type": "Interface", + "label": "BulkInstallPackagesRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BulkInstallPackagesRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L98" + }, + "signature": [ + "{ packages: string[]; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-common.MessageResponse", + "type": "Interface", + "label": "MessageResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.MessageResponse.response", + "type": "string", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L104" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L103" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeletePackageRequest", + "type": "Interface", + "label": "DeletePackageRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeletePackageRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L108" + }, + "signature": [ + "{ pkgkey: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L107" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeletePackageResponse", + "type": "Interface", + "label": "DeletePackageResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeletePackageResponse.response", + "type": "Array", + "label": "response", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L114" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetReference", + "text": "AssetReference" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L113" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetEnrollmentAPIKeysRequest", + "type": "Interface", + "label": "GetEnrollmentAPIKeysRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetEnrollmentAPIKeysRequest.query", + "type": "Object", + "label": "query", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L11" + }, + "signature": [ + "{ page: number; perPage: number; kuery?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetEnrollmentAPIKeysResponse", + "type": "Interface", + "label": "GetEnrollmentAPIKeysResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetEnrollmentAPIKeysResponse.list", + "type": "Array", + "label": "list", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L19" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EnrollmentAPIKey", + "text": "EnrollmentAPIKey" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.GetEnrollmentAPIKeysResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L20" + } + }, + { + "tags": [], + "id": "def-common.GetEnrollmentAPIKeysResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L21" + } + }, + { + "tags": [], + "id": "def-common.GetEnrollmentAPIKeysResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L22" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneEnrollmentAPIKeyRequest", + "type": "Interface", + "label": "GetOneEnrollmentAPIKeyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneEnrollmentAPIKeyRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L26" + }, + "signature": [ + "{ keyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L25" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneEnrollmentAPIKeyResponse", + "type": "Interface", + "label": "GetOneEnrollmentAPIKeyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneEnrollmentAPIKeyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L32" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EnrollmentAPIKey", + "text": "EnrollmentAPIKey" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteEnrollmentAPIKeyRequest", + "type": "Interface", + "label": "DeleteEnrollmentAPIKeyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteEnrollmentAPIKeyRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L36" + }, + "signature": [ + "{ keyId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L35" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DeleteEnrollmentAPIKeyResponse", + "type": "Interface", + "label": "DeleteEnrollmentAPIKeyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DeleteEnrollmentAPIKeyResponse.action", + "type": "string", + "label": "action", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L42" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L41" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostEnrollmentAPIKeyRequest", + "type": "Interface", + "label": "PostEnrollmentAPIKeyRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostEnrollmentAPIKeyRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L46" + }, + "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": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostEnrollmentAPIKeyResponse", + "type": "Interface", + "label": "PostEnrollmentAPIKeyResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostEnrollmentAPIKeyResponse.action", + "type": "string", + "label": "action", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.PostEnrollmentAPIKeyResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L55" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EnrollmentAPIKey", + "text": "EnrollmentAPIKey" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.InstallScriptRequest", + "type": "Interface", + "label": "InstallScriptRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.InstallScriptRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/install_script.ts#L9" + }, + "signature": [ + "{ osType: \"macos\"; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/install_script.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PostIngestSetupResponse", + "type": "Interface", + "label": "PostIngestSetupResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PostIngestSetupResponse.isInitialized", + "type": "boolean", + "label": "isInitialized", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts#L9" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneOutputResponse", + "type": "Interface", + "label": "GetOneOutputResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneOutputResponse.item", + "type": "CompoundType", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L11" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Output", + "text": "Output" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOneOutputRequest", + "type": "Interface", + "label": "GetOneOutputRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOneOutputRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L15" + }, + "signature": [ + "{ outputId: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutOutputRequest", + "type": "Interface", + "label": "PutOutputRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PutOutputRequest.params", + "type": "Object", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L21" + }, + "signature": [ + "{ outputId: string; }" + ] + }, + { + "tags": [], + "id": "def-common.PutOutputRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L24" + }, + "signature": [ + "{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record | undefined; config_yaml?: string | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutOutputResponse", + "type": "Interface", + "label": "PutOutputResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PutOutputResponse.item", + "type": "CompoundType", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L33" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Output", + "text": "Output" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetOutputsResponse", + "type": "Interface", + "label": "GetOutputsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetOutputsResponse.items", + "type": "Array", + "label": "items", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L37" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Output", + "text": "Output" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.GetOutputsResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L38" + } + }, + { + "tags": [], + "id": "def-common.GetOutputsResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L39" + } + }, + { + "tags": [], + "id": "def-common.GetOutputsResponse.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L40" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L36" + }, + "initialIsOpen": false + }, + { + "id": "def-common.GetSettingsResponse", + "type": "Interface", + "label": "GetSettingsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.GetSettingsResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L11" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Settings", + "text": "Settings" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutSettingsRequest", + "type": "Interface", + "label": "PutSettingsRequest", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PutSettingsRequest.body", + "type": "Object", + "label": "body", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L15" + }, + "signature": [ + "Partial>" + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PutSettingsResponse", + "type": "Interface", + "label": "PutSettingsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PutSettingsResponse.item", + "type": "Object", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L19" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Settings", + "text": "Settings" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.CheckPermissionsResponse", + "type": "Interface", + "label": "CheckPermissionsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.CheckPermissionsResponse.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L9" + }, + "signature": [ + "\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.CheckPermissionsResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L10" + } + } + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L8" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.InstallStatus", + "type": "Enum", + "label": "InstallStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KibanaAssetType", + "type": "Enum", + "label": "KibanaAssetType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-common.KibanaSavedObjectType", + "type": "Enum", + "label": "KibanaSavedObjectType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L56" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ElasticsearchAssetType", + "type": "Enum", + "label": "ElasticsearchAssetType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L65" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-common.SO_SEARCH_LIMIT", + "type": "number", + "label": "SO_SEARCH_LIMIT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L23" + }, + "signature": [ + "10000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FLEET_SERVER_INDICES_VERSION", + "type": "number", + "label": "FLEET_SERVER_INDICES_VERSION", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L25" + }, + "signature": [ + "1" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FLEET_SERVER_INDICES", + "type": "Array", + "label": "FLEET_SERVER_INDICES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L27" + }, + "signature": [ + "string[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PLUGIN_ID", + "type": "string", + "label": "PLUGIN_ID", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/plugin.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/plugin.ts#L8" + }, + "signature": [ + "\"fleet\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.API_ROOT", + "type": "string", + "label": "API_ROOT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L10" + }, + "signature": [ + "\"/api/fleet\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.EPM_API_ROOT", + "type": "string", + "label": "EPM_API_ROOT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L11" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DATA_STREAM_API_ROOT", + "type": "string", + "label": "DATA_STREAM_API_ROOT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L12" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROOT", + "type": "string", + "label": "PACKAGE_POLICY_API_ROOT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L13" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROOT", + "type": "string", + "label": "AGENT_POLICY_API_ROOT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L14" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FLEET_API_ROOT_7_9", + "type": "string", + "label": "FLEET_API_ROOT_7_9", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L15" + }, + "signature": [ + "\"/api/ingest_manager/fleet\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG", + "type": "string", + "label": "LIMITED_CONCURRENCY_ROUTE_TAG", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L17" + }, + "signature": [ + "\"ingest:limited-concurrency\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.SETUP_API_ROUTE", + "type": "string", + "label": "SETUP_API_ROUTE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L119" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.INSTALL_SCRIPT_API_ROUTES", + "type": "string", + "label": "INSTALL_SCRIPT_API_ROUTES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L121" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_SAVED_OBJECT_TYPE", + "type": "string", + "label": "AGENT_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L8" + }, + "signature": [ + "\"fleet-agents\"" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L11" + }, + "signature": [ + "\"fleet-agent-events\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_ACTION_SAVED_OBJECT_TYPE", + "type": "string", + "label": "AGENT_ACTION_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L12" + }, + "signature": [ + "\"fleet-agent-actions\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_TYPE_PERMANENT", + "type": "string", + "label": "AGENT_TYPE_PERMANENT", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L14" + }, + "signature": [ + "\"PERMANENT\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_TYPE_EPHEMERAL", + "type": "string", + "label": "AGENT_TYPE_EPHEMERAL", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L15" + }, + "signature": [ + "\"EPHEMERAL\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_TYPE_TEMPORARY", + "type": "string", + "label": "AGENT_TYPE_TEMPORARY", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L16" + }, + "signature": [ + "\"TEMPORARY\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS", + "type": "number", + "label": "AGENT_POLLING_REQUEST_TIMEOUT_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L18" + }, + "signature": [ + "300000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", + "type": "number", + "label": "AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L19" + }, + "signature": [ + "20000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLLING_THRESHOLD_MS", + "type": "number", + "label": "AGENT_POLLING_THRESHOLD_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L21" + }, + "signature": [ + "30000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLLING_INTERVAL", + "type": "number", + "label": "AGENT_POLLING_INTERVAL", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L22" + }, + "signature": [ + "1000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", + "type": "number", + "label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L23" + }, + "signature": [ + "30000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS", + "type": "number", + "label": "AGENT_UPDATE_ACTIONS_INTERVAL_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L24" + }, + "signature": [ + "5000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", + "type": "number", + "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L26" + }, + "signature": [ + "1000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", + "type": "number", + "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L27" + }, + "signature": [ + "5" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENTS_INDEX", + "type": "string", + "label": "AGENTS_INDEX", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L29" + }, + "signature": [ + "\".fleet-agents\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_ACTIONS_INDEX", + "type": "string", + "label": "AGENT_ACTIONS_INDEX", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L30" + }, + "signature": [ + "\".fleet-actions\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE", + "type": "string", + "label": "AGENT_POLICY_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L11" + }, + "signature": [ + "\"ingest-agent-policies\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_INDEX", + "type": "string", + "label": "AGENT_POLICY_INDEX", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L12" + }, + "signature": [ + "\".fleet-policies\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICIES_PACKAGES", + "type": "Array", + "label": "DEFAULT_AGENT_POLICIES_PACKAGES", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L47" + }, + "signature": [ + "\"system\"[]" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE", + "type": "string", + "label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/package_policy.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/package_policy.ts#L8" + }, + "signature": [ + "\"ingest-package-policies\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.PACKAGES_SAVED_OBJECT_TYPE", + "type": "string", + "label": "PACKAGES_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L8" + }, + "signature": [ + "\"epm-packages\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ASSETS_SAVED_OBJECT_TYPE", + "type": "string", + "label": "ASSETS_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L9" + }, + "signature": [ + "\"epm-packages-assets\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE", + "type": "string", + "label": "INDEX_PATTERN_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L10" + }, + "signature": [ + "\"index-pattern\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.MAX_TIME_COMPLETE_INSTALL", + "type": "number", + "label": "MAX_TIME_COMPLETE_INSTALL", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L11" + }, + "signature": [ + "60000" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.FLEET_SERVER_PACKAGE", + "type": "string", + "label": "FLEET_SERVER_PACKAGE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L13" + }, + "signature": [ + "\"fleet_server\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.OUTPUT_SAVED_OBJECT_TYPE", + "type": "string", + "label": "OUTPUT_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L10" + }, + "signature": [ + "\"ingest-outputs\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE", + "type": "string", + "label": "ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/enrollment_api_key.ts#L8" + }, + "signature": [ + "\"fleet-enrollment-api-keys\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEYS_INDEX", + "type": "string", + "label": "ENROLLMENT_API_KEYS_INDEX", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/enrollment_api_key.ts#L10" + }, + "signature": [ + "\".fleet-enrollment-api-keys\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", + "type": "string", + "label": "GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/settings.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/settings.ts#L8" + }, + "signature": [ + "\"ingest_manager_settings\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ValueOf", + "type": "Type", + "label": "ValueOf", + "tags": [], + "description": [ + "\nCreates a Union Type for all the values of an object" + ], + "source": { + "path": "x-pack/plugins/fleet/common/types/index.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L44" + }, + "signature": [ + "T[keyof T]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentType", + "type": "Type", + "label": "AgentType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L11" + }, + "signature": [ + "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentStatus", + "type": "Type", + "label": "AgentStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L16" + }, + "signature": [ + "\"warning\" | \"offline\" | \"online\" | \"error\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.SimplifiedAgentStatus", + "type": "Type", + "label": "SimplifiedAgentStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L27" + }, + "signature": [ + "\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentActionType", + "type": "Type", + "label": "AgentActionType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L29" + }, + "signature": [ + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"INTERNAL_POLICY_REASSIGN\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicyActionV7_9", + "type": "Type", + "label": "AgentPolicyActionV7_9", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L67" + }, + "signature": [ + "Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentActionSOAttributes", + "type": "Type", + "label": "AgentActionSOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L83" + }, + "signature": [ + "CommonAgentActionSOAttributes & { agent_id: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicyActionSOAttributes", + "type": "Type", + "label": "AgentPolicyActionSOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L86" + }, + "signature": [ + "CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.BaseAgentActionSOAttributes", + "type": "Type", + "label": "BaseAgentActionSOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L90" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentActionSOAttributes", + "text": "AgentActionSOAttributes" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicyActionSOAttributes", + "text": "AgentPolicyActionSOAttributes" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentEventSOAttributes", + "type": "Type", + "label": "AgentEventSOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L122" + }, + "signature": [ + "NewAgentEvent" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicyStatus", + "type": "Type", + "label": "AgentPolicyStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L13" + }, + "signature": [ + "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentPolicySOAttributes", + "type": "Type", + "label": "AgentPolicySOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L35" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicyConfigRecord", + "type": "Type", + "label": "PackagePolicyConfigRecord", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L19" + }, + "signature": [ + "{ [x: string]: PackagePolicyConfigRecordEntry; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackagePolicySOAttributes", + "type": "Type", + "label": "PackagePolicySOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L75" + }, + "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; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.OutputType", + "type": "Type", + "label": "OutputType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L11" + }, + "signature": [ + "{ readonly Elasticsearch: \"elasticsearch\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.OutputSOAttributes", + "type": "Type", + "label": "OutputSOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L26" + }, + "signature": [ + "NewOutput" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Output", + "type": "Type", + "label": "Output", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L28" + }, + "signature": [ + "NewOutput & { id: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InstallationStatus", + "type": "Type", + "label": "InstallationStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L22" + }, + "signature": [ + "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InstallType", + "type": "Type", + "label": "InstallType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L31" + }, + "signature": [ + "\"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InstallSource", + "type": "Type", + "label": "InstallSource", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L32" + }, + "signature": [ + "\"registry\" | \"upload\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EpmPackageInstallStatus", + "type": "Type", + "label": "EpmPackageInstallStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L34" + }, + "signature": [ + "\"installed\" | \"installing\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DetailViewPanelName", + "type": "Type", + "label": "DetailViewPanelName", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L36" + }, + "signature": [ + "\"custom\" | \"overview\" | \"policies\" | \"settings\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ServiceName", + "type": "Type", + "label": "ServiceName", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L37" + }, + "signature": [ + "\"kibana\" | \"elasticsearch\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AgentAssetType", + "type": "Type", + "label": "AgentAssetType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L38" + }, + "signature": [ + "{ readonly Input: \"input\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AssetType", + "type": "Type", + "label": "AssetType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L39" + }, + "signature": [ + "\"input\" | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ".dashboard | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ".visualization | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ".search | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + ".indexPattern | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.DataType", + "type": "Type", + "label": "DataType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L74" + }, + "signature": [ + "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.InstallablePackage", + "type": "Type", + "label": "InstallablePackage", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L76" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ArchivePackage", + "text": "ArchivePackage" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.ArchivePackage", + "type": "Type", + "label": "ArchivePackage", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L78" + }, + "signature": [ + "PackageSpecManifest & Pick" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RegistryPackage", + "type": "Type", + "label": "RegistryPackage", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L82" + }, + "signature": [ + "PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RegistryRelease", + "type": "Type", + "label": "RegistryRelease", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L109" + }, + "signature": [ + "\"experimental\" | \"beta\" | \"ga\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RequirementVersion", + "type": "Type", + "label": "RequirementVersion", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L142" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RequirementVersionRange", + "type": "Type", + "label": "RequirementVersionRange", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L143" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RegistrySearchResults", + "type": "Type", + "label": "RegistrySearchResults", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L151" + }, + "signature": [ + "Pick[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RegistrySearchResult", + "type": "Type", + "label": "RegistrySearchResult", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L153" + }, + "signature": [ + "{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" + }, + "[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; internal?: boolean | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ScreenshotItem", + "type": "Type", + "label": "ScreenshotItem", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L169" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryImage", + "text": "RegistryImage" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecScreenshot", + "text": "PackageSpecScreenshot" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.CategorySummaryList", + "type": "Type", + "label": "CategorySummaryList", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L173" + }, + "signature": [ + "CategorySummaryItem[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.CategoryId", + "type": "Type", + "label": "CategoryId", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 174, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L174" + }, + "signature": [ + "string" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RequirementsByServiceName", + "type": "Type", + "label": "RequirementsByServiceName", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L181" + }, + "signature": [ + "undefined | Record<\"kibana\", { version: string; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AssetTypeToParts", + "type": "Type", + "label": "AssetTypeToParts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L189" + }, + "signature": [ + "Record & Record" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AssetsGroupedByServiceByType", + "type": "Type", + "label": "AssetsGroupedByServiceByType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L190" + }, + "signature": [ + "Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.KibanaAssetParts", + "type": "Type", + "label": "KibanaAssetParts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L196" + }, + "signature": [ + "AssetParts & { service: Extract; type: KibanaAssetType; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ElasticsearchAssetParts", + "type": "Type", + "label": "ElasticsearchAssetParts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 201, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L201" + }, + "signature": [ + "AssetParts & { service: Extract; type: ElasticsearchAssetType; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.KibanaAssetTypeToParts", + "type": "Type", + "label": "KibanaAssetTypeToParts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 206, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L206" + }, + "signature": [ + "{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ElasticsearchAssetTypeToParts", + "type": "Type", + "label": "ElasticsearchAssetTypeToParts", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L207" + }, + "signature": [ + "{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RegistryVarType", + "type": "Type", + "label": "RegistryVarType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 232, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L232" + }, + "signature": [ + "\"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageList", + "type": "Type", + "label": "PackageList", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 265, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L265" + }, + "signature": [ + "Installable>[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageListItem", + "type": "Type", + "label": "PackageListItem", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L267" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + ">" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackagesGroupedByStatus", + "type": "Type", + "label": "PackagesGroupedByStatus", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L268" + }, + "signature": [ + "{ installed: PackageList; not_installed: PackageList; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageInfo", + "type": "Type", + "label": "PackageInfo", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L269" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installed", + "text": "Installed" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" + }, + "" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Installed", + "type": "Type", + "label": "Installed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L292" + }, + "signature": [ + "T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.NotInstalled", + "type": "Type", + "label": "NotInstalled", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L297" + }, + "signature": [ + "T & { status: InstallationStatus['NotInstalled']; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.AssetReference", + "type": "Type", + "label": "AssetReference", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L301" + }, + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EsAssetReference", + "text": "EsAssetReference" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetReference", + "text": "KibanaAssetReference" + } + ], + "initialIsOpen": false + }, + { + "id": "def-common.KibanaAssetReference", + "type": "Type", + "label": "KibanaAssetReference", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 303, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L303" + }, + "signature": [ + "Pick & { type: KibanaSavedObjectType; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EsAssetReference", + "type": "Type", + "label": "EsAssetReference", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 306, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L306" + }, + "signature": [ + "Pick & { type: ElasticsearchAssetType; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageAssetReference", + "type": "Type", + "label": "PackageAssetReference", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 310, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L310" + }, + "signature": [ + "Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.RequiredPackage", + "type": "Type", + "label": "RequiredPackage", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 314, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L314" + }, + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DefaultPackages", + "type": "Type", + "label": "DefaultPackages", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "lineNumber": 316, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L316" + }, + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageSpecCategory", + "type": "Type", + "label": "PackageSpecCategory", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L28" + }, + "signature": [ + "\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.PackageSpecConditions", + "type": "Type", + "label": "PackageSpecConditions", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L53" + }, + "signature": [ + "{ kibana: { version: string; }; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.EnrollmentAPIKeySOAttributes", + "type": "Type", + "label": "EnrollmentAPIKeySOAttributes", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L18" + }, + "signature": [ + "{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UpdatePackagePolicyRequest", + "type": "Type", + "label": "UpdatePackagePolicyRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L43" + }, + "signature": [ + "GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UpdatePackagePolicyResponse", + "type": "Type", + "label": "UpdatePackagePolicyResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L47" + }, + "signature": [ + "CreatePackagePolicyResponse" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DeletePackagePoliciesResponse", + "type": "Type", + "label": "DeletePackagePoliciesResponse", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L55" + }, + "signature": [ + "{ id: string; name?: string | undefined; success: boolean; }[]" + ], + "initialIsOpen": false + }, + { + "id": "def-common.GetAgentPoliciesResponseItem", + "type": "Type", + "label": "GetAgentPoliciesResponseItem", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L17" + }, + "signature": [ + "AgentPolicy & { agents?: number | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.UpdateAgentPolicyRequest", + "type": "Type", + "label": "UpdateAgentPolicyRequest", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L44" + }, + "signature": [ + "GetOneAgentPolicyRequest & { body: NewAgentPolicy; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-common.EPM_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN", + "type": "string", + "label": "BULK_INSTALL_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L25" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L26" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN", + "type": "string", + "label": "LIMITED_LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L27" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L28" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN", + "type": "string", + "label": "INSTALL_FROM_REGISTRY_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L29" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN", + "type": "string", + "label": "INSTALL_BY_UPLOAD_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L30" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", + "type": "string", + "label": "DELETE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN", + "type": "string", + "label": "FILEPATH_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L32" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN", + "type": "string", + "label": "CATEGORIES_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L33" + } + }, + { + "tags": [], + "id": "def-common.EPM_API_ROUTES.STATS_PATTERN", + "type": "string", + "label": "STATS_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L34" + } + } + ], + "description": [], + "label": "EPM_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DATA_STREAM_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L39" + } + } + ], + "description": [], + "label": "DATA_STREAM_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L38" + }, + "initialIsOpen": false + }, + { + "id": "def-common.PACKAGE_POLICY_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L44" + } + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L45" + } + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN", + "type": "string", + "label": "CREATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L46" + } + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN", + "type": "string", + "label": "UPDATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L47" + } + }, + { + "tags": [], + "id": "def-common.PACKAGE_POLICY_API_ROUTES.DELETE_PATTERN", + "type": "string", + "label": "DELETE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L48" + } + } + ], + "description": [], + "label": "PACKAGE_POLICY_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L43" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AGENT_POLICY_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L53" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN", + "type": "string", + "label": "CREATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L55" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN", + "type": "string", + "label": "UPDATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN", + "type": "string", + "label": "COPY_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN", + "type": "string", + "label": "DELETE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L58" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN", + "type": "string", + "label": "FULL_INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L59" + } + }, + { + "tags": [], + "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN", + "type": "string", + "label": "FULL_INFO_DOWNLOAD_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L60" + } + } + ], + "description": [], + "label": "AGENT_POLICY_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L52" + }, + "initialIsOpen": false + }, + { + "id": "def-common.OUTPUT_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.OUTPUT_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L65" + } + }, + { + "tags": [], + "id": "def-common.OUTPUT_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L66" + } + }, + { + "tags": [], + "id": "def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN", + "type": "string", + "label": "UPDATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L67" + } + } + ], + "description": [], + "label": "OUTPUT_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-common.SETTINGS_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SETTINGS_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L72" + } + }, + { + "tags": [], + "id": "def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN", + "type": "string", + "label": "UPDATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L73" + } + } + ], + "description": [], + "label": "SETTINGS_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L71" + }, + "initialIsOpen": false + }, + { + "id": "def-common.APP_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN", + "type": "string", + "label": "CHECK_PERMISSIONS_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L78" + } + } + ], + "description": [], + "label": "APP_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L77" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AGENT_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L83" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L84" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN", + "type": "string", + "label": "UPDATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L85" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN", + "type": "string", + "label": "DELETE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L86" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L87" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN", + "type": "string", + "label": "CHECKIN_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L88" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN", + "type": "string", + "label": "ACKS_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L89" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN", + "type": "string", + "label": "ACTIONS_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L90" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.ENROLL_PATTERN", + "type": "string", + "label": "ENROLL_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L91" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN", + "type": "string", + "label": "UNENROLL_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L92" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN", + "type": "string", + "label": "BULK_UNENROLL_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L93" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN", + "type": "string", + "label": "REASSIGN_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 94, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L94" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN", + "type": "string", + "label": "BULK_REASSIGN_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L95" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN", + "type": "string", + "label": "STATUS_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L96" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN", + "type": "string", + "label": "UPGRADE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L97" + } + }, + { + "tags": [], + "id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN", + "type": "string", + "label": "BULK_UPGRADE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 98, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L98" + } + } + ], + "description": [], + "label": "AGENT_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L82" + }, + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L101" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L102" + } + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L103" + } + } + ], + "description": [], + "label": "AGENT_API_ROUTES_7_9", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L100" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ENROLLMENT_API_KEY_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN", + "type": "string", + "label": "CREATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L107" + } + }, + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN", + "type": "string", + "label": "LIST_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L108" + } + }, + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L109" + } + }, + { + "tags": [], + "id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN", + "type": "string", + "label": "DELETE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L110" + } + } + ], + "description": [], + "label": "ENROLLMENT_API_KEY_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 106, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L106" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AGENTS_SETUP_API_ROUTES", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN", + "type": "string", + "label": "INFO_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L115" + } + }, + { + "tags": [], + "id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN", + "type": "string", + "label": "CREATE_PATTERN", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L116" + } + } + ], + "description": [], + "label": "AGENTS_SETUP_API_ROUTES", + "source": { + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L114" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.agentPolicyStatuses", + "type": "Object", + "label": "agentPolicyStatuses", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L13" + }, + "signature": [ + "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DEFAULT_AGENT_POLICY", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L22" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L23" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L24" + } + }, + { + "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": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L25" + }, + "signature": [ + "\"active\"" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.package_policies", + "type": "Array", + "label": "package_policies", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L26" + }, + "signature": [ + "never[]" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.is_default", + "type": "boolean", + "label": "is_default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L27" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.is_managed", + "type": "boolean", + "label": "is_managed", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L28" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_AGENT_POLICY.monitoring_enabled", + "type": "Array", + "label": "monitoring_enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L29" + }, + "signature": [ + "(\"metrics\" | \"logs\")[]" + ] + } + ], + "description": [], + "label": "DEFAULT_AGENT_POLICY", + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L18" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L36" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.namespace", + "type": "string", + "label": "namespace", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L38" + } + }, + { + "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": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L39" + }, + "signature": [ + "\"active\"" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies", + "type": "Array", + "label": "package_policies", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L40" + }, + "signature": [ + "never[]" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default", + "type": "boolean", + "label": "is_default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L41" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default_fleet_server", + "type": "boolean", + "label": "is_default_fleet_server", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L42" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed", + "type": "boolean", + "label": "is_managed", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L43" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled", + "type": "Array", + "label": "monitoring_enabled", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L44" + }, + "signature": [ + "(\"metrics\" | \"logs\")[]" + ] + } + ], + "description": [], + "label": "DEFAULT_FLEET_SERVER_AGENT_POLICY", + "source": { + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L32" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.requiredPackages", + "type": "Object", + "label": "requiredPackages", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L15" + }, + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.defaultPackages", + "type": "Object", + "label": "defaultPackages", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L22" + }, + "signature": [ + "{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.agentAssetTypes", + "type": "Object", + "label": "agentAssetTypes", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L24" + }, + "signature": [ + "{ readonly Input: \"input\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.dataTypes", + "type": "Object", + "label": "dataTypes", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L28" + }, + "signature": [ + "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.installationStatuses", + "type": "Object", + "label": "installationStatuses", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L33" + }, + "signature": [ + "{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.outputType", + "type": "Object", + "label": "outputType", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L12" + }, + "signature": [ + "{ readonly Elasticsearch: \"elasticsearch\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.DEFAULT_OUTPUT", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DEFAULT_OUTPUT.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L17" + } + }, + { + "tags": [], + "id": "def-common.DEFAULT_OUTPUT.is_default", + "type": "boolean", + "label": "is_default", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L18" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_OUTPUT.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L19" + }, + "signature": [ + "\"elasticsearch\"" + ] + }, + { + "tags": [], + "id": "def-common.DEFAULT_OUTPUT.hosts", + "type": "Array", + "label": "hosts", + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L20" + }, + "signature": [ + "string[]" + ] + } + ], + "description": [], + "label": "DEFAULT_OUTPUT", + "source": { + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-common.AgentStatusKueryHelper", + "type": "Object", + "label": "AgentStatusKueryHelper", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/index.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/index.ts#L9" + }, + "signature": [ + "typeof ", + "x-pack/plugins/fleet/common/services/agent_status" + ], + "initialIsOpen": false + }, + { + "id": "def-common.epmRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.epmRouteService.getCategoriesPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getCategoriesPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L24" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L28" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getListLimitedPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListLimitedPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L32" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "pkgkey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L36" + } + } + ], + "signature": [ + "(pkgkey: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L36" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getStatsPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "pkgName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L40" + } + } + ], + "signature": [ + "(pkgName: string) => string" + ], + "description": [], + "label": "getStatsPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L40" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getFilePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "filePath", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L44" + } + } + ], + "signature": [ + "(filePath: string) => string" + ], + "description": [], + "label": "getFilePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L44" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getInstallPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "pkgkey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L48" + } + } + ], + "signature": [ + "(pkgkey: string) => string" + ], + "description": [], + "label": "getInstallPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L48" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getBulkInstallPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getBulkInstallPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L55" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.epmRouteService.getRemovePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "pkgkey", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L59" + } + } + ], + "signature": [ + "(pkgkey: string) => string" + ], + "description": [], + "label": "getRemovePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L59" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "epmRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-common.packagePolicyRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.packagePolicyRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L65" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.packagePolicyRouteService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "packagePolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L69" + } + } + ], + "signature": [ + "(packagePolicyId: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L69" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.packagePolicyRouteService.getCreatePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getCreatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L73" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.packagePolicyRouteService.getUpdatePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "packagePolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L77" + } + } + ], + "signature": [ + "(packagePolicyId: string) => string" + ], + "description": [], + "label": "getUpdatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L77" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.packagePolicyRouteService.getDeletePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getDeletePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L81" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "packagePolicyRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-common.agentPolicyRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.agentPolicyRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L87" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L91" + } + } + ], + "signature": [ + "(agentPolicyId: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 91, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L91" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getCreatePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getCreatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L95" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getUpdatePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L99" + } + } + ], + "signature": [ + "(agentPolicyId: string) => string" + ], + "description": [], + "label": "getUpdatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L99" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getCopyPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L103" + } + } + ], + "signature": [ + "(agentPolicyId: string) => string" + ], + "description": [], + "label": "getCopyPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L103" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getDeletePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getDeletePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 107, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L107" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getInfoFullPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L111" + } + } + ], + "signature": [ + "(agentPolicyId: string) => string" + ], + "description": [], + "label": "getInfoFullPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L111" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentPolicyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L115" + } + } + ], + "signature": [ + "(agentPolicyId: string) => string" + ], + "description": [], + "label": "getInfoFullDownloadPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L115" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "agentPolicyRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L86" + }, + "initialIsOpen": false + }, + { + "id": "def-common.dataStreamRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.dataStreamRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L124" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "dataStreamRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L123" + }, + "initialIsOpen": false + }, + { + "id": "def-common.fleetSetupRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.fleetSetupRouteService.getFleetSetupPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getFleetSetupPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L130" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.fleetSetupRouteService.postFleetSetupPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "postFleetSetupPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L131" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "fleetSetupRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L129" + }, + "initialIsOpen": false + }, + { + "id": "def-common.agentRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.agentRouteService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L135" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 135, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L135" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getUpdatePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L136" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getUpdatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L136" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getEventsPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L137" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getEventsPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 137, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L137" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getUnenrollPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L138" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getUnenrollPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 138, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L138" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getBulkUnenrollPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getBulkUnenrollPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L140" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getReassignPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L141" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getReassignPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L141" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getBulkReassignPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getBulkReassignPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L143" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getUpgradePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L144" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getUpgradePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L144" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getBulkUpgradePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getBulkUpgradePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 146, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L146" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L147" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getStatusPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getStatusPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 148, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L148" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.agentRouteService.getCreateActionPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "agentId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 149, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L149" + } + } + ], + "signature": [ + "(agentId: string) => string" + ], + "description": [], + "label": "getCreateActionPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 149, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L149" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "agentRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 134, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L134" + }, + "initialIsOpen": false + }, + { + "id": "def-common.outputRoutesService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.outputRoutesService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "outputId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L154" + } + } + ], + "signature": [ + "(outputId: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L154" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.outputRoutesService.getUpdatePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "outputId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L155" + } + } + ], + "signature": [ + "(outputId: string) => string" + ], + "description": [], + "label": "getUpdatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L155" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.outputRoutesService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 157, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L157" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "outputRoutesService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 153, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L153" + }, + "initialIsOpen": false + }, + { + "id": "def-common.settingsRoutesService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.settingsRoutesService.getInfoPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L161" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.settingsRoutesService.getUpdatePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getUpdatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L162" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "settingsRoutesService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 160, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L160" + }, + "initialIsOpen": false + }, + { + "id": "def-common.appRoutesService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.appRoutesService.getCheckPermissionsPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getCheckPermissionsPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L166" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "appRoutesService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L165" + }, + "initialIsOpen": false + }, + { + "id": "def-common.enrollmentAPIKeyRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.enrollmentAPIKeyRouteService.getListPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getListPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L170" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.enrollmentAPIKeyRouteService.getCreatePath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getCreatePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 171, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L171" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "keyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L172" + } + } + ], + "signature": [ + "(keyId: string) => string" + ], + "description": [], + "label": "getInfoPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L172" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath", + "type": "Function", + "children": [ + { + "type": "string", + "label": "keyId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L173" + } + } + ], + "signature": [ + "(keyId: string) => string" + ], + "description": [], + "label": "getDeletePath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L173" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "enrollmentAPIKeyRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L169" + }, + "initialIsOpen": false + }, + { + "id": "def-common.setupRouteService", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.setupRouteService.getSetupPath", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], + "description": [], + "label": "getSetupPath", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L178" + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "setupRouteService", + "source": { + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L177" + }, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx new file mode 100644 index 0000000000000..d64864ca5c800 --- /dev/null +++ b/api_docs/fleet.mdx @@ -0,0 +1,73 @@ +--- +id: kibFleetPluginApi +slug: /kibana-dev-docs/fleetPluginApi +title: fleet +image: https://source.unsplash.com/400x175/?github +summary: API docs for the fleet plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import fleetObj from './fleet.json'; + +## Client + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/global_search.json b/api_docs/global_search.json new file mode 100644 index 0000000000000..0f5b9e711cba4 --- /dev/null +++ b/api_docs/global_search.json @@ -0,0 +1,1383 @@ +{ + "id": "globalSearch", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.GlobalSearchBatchedResults", + "type": "Interface", + "label": "GlobalSearchBatchedResults", + "description": [ + "\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchBatchedResults.results", + "type": "Array", + "label": "results", + "description": [ + "\nResults for this batch" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L89" + }, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchResult", + "text": "GlobalSearchResult" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L85" + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchProviderFindOptions", + "type": "Interface", + "label": "GlobalSearchProviderFindOptions", + "description": [ + "\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchProviderFindOptions.preference", + "type": "string", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderFindOptions.aborted$", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L28" + }, + "signature": [ + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderFindOptions.maxResults", + "type": "number", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L33" + } + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchProviderResult", + "type": "Interface", + "label": "GlobalSearchProviderResult", + "description": [ + "\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.id", + "type": "string", + "label": "id", + "description": [ + "an id that should be unique for an individual provider's results" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L46" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.title", + "type": "string", + "label": "title", + "description": [ + "the title/label of the result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L48" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.type", + "type": "string", + "label": "type", + "description": [ + "the type of result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L50" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.icon", + "type": "string", + "label": "icon", + "description": [ + "an optional EUI icon name to associate with the search result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L52" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-public.GlobalSearchProviderResult.url", + "type": "CompoundType", + "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" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L62" + }, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderResultUrl", + "text": "GlobalSearchProviderResultUrl" + } + ] + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.score", + "type": "number", + "label": "score", + "description": [ + "the score of the result, from 1 (lowest) to 100 (highest)" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L64" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchProviderResult.meta", + "type": "Object", + "label": "meta", + "description": [ + "an optional record of metadata for this result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L66" + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchFindParams", + "type": "Interface", + "label": "GlobalSearchFindParams", + "description": [ + "\nSearch parameters for the {@link GlobalSearchPluginStart.find | `find` API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchFindParams.term", + "type": "string", + "label": "term", + "description": [ + "\nThe term to search for. Can be undefined if searching by filters." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L101" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.GlobalSearchFindParams.types", + "type": "Array", + "label": "types", + "description": [ + "\nThe types of results to search for." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L105" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.GlobalSearchFindParams.tags", + "type": "Array", + "label": "tags", + "description": [ + "\nThe tag ids to filter search by." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L109" + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L97" + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchResultProvider", + "type": "Interface", + "label": "GlobalSearchResultProvider", + "description": [ + "\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchResultProvider.id", + "type": "string", + "label": "id", + "description": [ + "\nid of the provider" + ], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L26" + } + }, + { + "id": "def-public.GlobalSearchResultProvider.find", + "type": "Function", + "label": "find", + "signature": [ + "(search: ", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + }, + ", options: ", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderFindOptions", + "text": "GlobalSearchProviderFindOptions" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderResult", + "text": "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" + ], + "children": [ + { + "type": "Object", + "label": "search", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L45" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderFindOptions", + "text": "GlobalSearchProviderFindOptions" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L46" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L44" + } + }, + { + "tags": [], + "id": "def-public.GlobalSearchResultProvider.getSearchableTypes", + "type": "Function", + "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/public/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L53" + }, + "signature": [ + "() => string[] | Promise" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchFindOptions", + "type": "Interface", + "label": "GlobalSearchFindOptions", + "description": [ + "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.GlobalSearchFindOptions.preference", + "type": "string", + "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'" + ], + "source": { + "path": "x-pack/plugins/global_search/public/services/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L22" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.GlobalSearchFindOptions.aborted$", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/public/services/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L27" + }, + "signature": [ + "Observable", + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/public/services/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L13" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.GlobalSearchProviderResultUrl", + "type": "Type", + "label": "GlobalSearchProviderResultUrl", + "tags": [], + "description": [ + "\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L39" + }, + "signature": [ + "string | { path: string; prependBasePath: boolean; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchResult", + "type": "Type", + "label": "GlobalSearchResult", + "tags": [], + "description": [ + "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L72" + }, + "signature": [ + "Pick & { url: string; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchProviderFindParams", + "type": "Type", + "label": "GlobalSearchProviderFindParams", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L115" + }, + "signature": [ + "GlobalSearchFindParams" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.GlobalSearchPluginSetup", + "type": "Type", + "label": "GlobalSearchPluginSetup", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L16" + }, + "signature": [ + "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.GlobalSearchPluginStart", + "type": "Type", + "label": "GlobalSearchPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/public/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L17" + }, + "signature": [ + "{ find: (params: ", + "GlobalSearchFindParams", + ", options: ", + { + "pluginId": "globalSearch", + "scope": "public", + "docId": "kibGlobalSearchPluginApi", + "section": "def-public.GlobalSearchFindOptions", + "text": "GlobalSearchFindOptions" + }, + ") => Observable<", + "GlobalSearchBatchedResults", + ">; getSearchableTypes: () => Promise; }" + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.GlobalSearchBatchedResults", + "type": "Interface", + "label": "GlobalSearchBatchedResults", + "description": [ + "\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchBatchedResults.results", + "type": "Array", + "label": "results", + "description": [ + "\nResults for this batch" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L89" + }, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchResult", + "text": "GlobalSearchResult" + }, + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L85" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchProviderFindOptions", + "type": "Interface", + "label": "GlobalSearchProviderFindOptions", + "description": [ + "\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchProviderFindOptions.preference", + "type": "string", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L20" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderFindOptions.aborted$", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L28" + }, + "signature": [ + "Observable", + "" + ] + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderFindOptions.maxResults", + "type": "number", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L33" + } + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchProviderResult", + "type": "Interface", + "label": "GlobalSearchProviderResult", + "description": [ + "\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.id", + "type": "string", + "label": "id", + "description": [ + "an id that should be unique for an individual provider's results" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L46" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.title", + "type": "string", + "label": "title", + "description": [ + "the title/label of the result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L48" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.type", + "type": "string", + "label": "type", + "description": [ + "the type of result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L50" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.icon", + "type": "string", + "label": "icon", + "description": [ + "an optional EUI icon name to associate with the search result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L52" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "example" + ], + "id": "def-server.GlobalSearchProviderResult.url", + "type": "CompoundType", + "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" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L62" + }, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderResultUrl", + "text": "GlobalSearchProviderResultUrl" + } + ] + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.score", + "type": "number", + "label": "score", + "description": [ + "the score of the result, from 1 (lowest) to 100 (highest)" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L64" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchProviderResult.meta", + "type": "Object", + "label": "meta", + "description": [ + "an optional record of metadata for this result" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L66" + }, + "signature": [ + "Record | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchFindOptions", + "type": "Interface", + "label": "GlobalSearchFindOptions", + "description": [ + "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchFindOptions.preference", + "type": "string", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L95" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.GlobalSearchFindOptions.aborted$", + "type": "Object", + "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." + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L100" + }, + "signature": [ + "Observable", + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L88" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchProviderContext", + "type": "Interface", + "label": "GlobalSearchProviderContext", + "description": [ + "\nContext passed to server-side {@GlobalSearchResultProvider | result provider}'s `find` method.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchProviderContext.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L66" + }, + "signature": [ + "{ savedObjects: { client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" + }, + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; }; elasticsearch: { legacy: { client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" + }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">; }; }; uiSettings: { client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + "; }; capabilities: ", + "Observable" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchResultProvider", + "type": "Interface", + "label": "GlobalSearchResultProvider", + "description": [ + "\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchResultProvider.id", + "type": "string", + "label": "id", + "description": [ + "\nid of the provider" + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L112" + } + }, + { + "id": "def-server.GlobalSearchResultProvider.find", + "type": "Function", + "label": "find", + "signature": [ + "(search: ", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + }, + ", options: ", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderFindOptions", + "text": "GlobalSearchProviderFindOptions" + }, + ", context: ", + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchProviderContext", + "text": "GlobalSearchProviderContext" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderResult", + "text": "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" + ], + "children": [ + { + "type": "Object", + "label": "search", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L131" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchProviderFindOptions", + "text": "GlobalSearchProviderFindOptions" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L132" + } + }, + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchProviderContext", + "text": "GlobalSearchProviderContext" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 133, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L133" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L130" + } + }, + { + "tags": [], + "id": "def-server.GlobalSearchResultProvider.getSearchableTypes", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L140" + }, + "signature": [ + "(context: ", + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchProviderContext", + "text": "GlobalSearchProviderContext" + }, + ") => string[] | Promise" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 108, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L108" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RouteHandlerGlobalSearchContext", + "type": "Interface", + "label": "RouteHandlerGlobalSearchContext", + "description": [ + "\nglobalSearch route handler context.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "id": "def-server.RouteHandlerGlobalSearchContext.find", + "type": "Function", + "label": "find", + "signature": [ + "(params: ", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + }, + ", options: ", + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchFindOptions", + "text": "GlobalSearchFindOptions" + }, + ") => ", + "Observable", + "<", + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchBatchedResults", + "text": "GlobalSearchBatchedResults" + }, + ">" + ], + "description": [ + "\nSee {@link SearchServiceStart.find | the find API}" + ], + "children": [ + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "common", + "docId": "kibGlobalSearchPluginApi", + "section": "def-common.GlobalSearchFindParams", + "text": "GlobalSearchFindParams" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L51" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "globalSearch", + "scope": "server", + "docId": "kibGlobalSearchPluginApi", + "section": "def-server.GlobalSearchFindOptions", + "text": "GlobalSearchFindOptions" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L52" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L50" + } + }, + { + "tags": [], + "id": "def-server.RouteHandlerGlobalSearchContext.getSearchableTypes", + "type": "Function", + "label": "getSearchableTypes", + "description": [ + "\nSee {@link SearchServiceStart.getSearchableTypes | the getSearchableTypes API}" + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L57" + }, + "signature": [ + "() => Promise" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L46" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.GlobalSearchProviderResultUrl", + "type": "Type", + "label": "GlobalSearchProviderResultUrl", + "tags": [], + "description": [ + "\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L39" + }, + "signature": [ + "string | { path: string; prependBasePath: boolean; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchResult", + "type": "Type", + "label": "GlobalSearchResult", + "tags": [], + "description": [ + "\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}" + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L72" + }, + "signature": [ + "Pick & { url: string; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "id": "def-server.GlobalSearchPluginStart", + "type": "Type", + "label": "GlobalSearchPluginStart", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L28" + }, + "signature": [ + "{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Observable; getSearchableTypes: (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => Promise; }" + ], + "lifecycle": "start", + "initialIsOpen": true + }, + "setup": { + "id": "def-server.GlobalSearchPluginSetup", + "type": "Type", + "label": "GlobalSearchPluginSetup", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L27" + }, + "signature": [ + "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" + ], + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx new file mode 100644 index 0000000000000..2e88a252eb35d --- /dev/null +++ b/api_docs/global_search.mdx @@ -0,0 +1,41 @@ +--- +id: kibGlobalSearchPluginApi +slug: /kibana-dev-docs/globalSearchPluginApi +title: globalSearch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the globalSearch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import globalSearchObj from './global_search.json'; + +## Client + +### Setup + + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/home.json b/api_docs/home.json new file mode 100644 index 0000000000000..2043b0066d976 --- /dev/null +++ b/api_docs/home.json @@ -0,0 +1,1504 @@ +{ + "id": "home", + "client": { + "classes": [], + "functions": [ + { + "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" + ], + "description": [ + "\nConvert instruction variant id into display text.\n" + ], + "children": [ + { + "type": "CompoundType", + "label": "id", + "isRequired": true, + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L55" + } + } + ], + "tags": [ + "params", + "return" + ], + "returnComment": [ + "display name" + ], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L55" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.FeatureCatalogueEntry", + "type": "Interface", + "label": "FeatureCatalogueEntry", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.id", + "type": "string", + "label": "id", + "description": [ + "Unique string identifier for this feature." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L22" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.title", + "type": "string", + "label": "title", + "description": [ + "Title of feature displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.category", + "type": "Enum", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L26" + }, + "signature": [ + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueCategory", + "text": "FeatureCatalogueCategory" + } + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.subtitle", + "type": "string", + "label": "subtitle", + "description": [ + "A tagline of feature displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L28" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.description", + "type": "string", + "label": "description", + "description": [ + "One-line description of feature displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L30" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.icon", + "type": "CompoundType", + "label": "icon", + "description": [ + "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L32" + }, + "signature": [ + "IconType" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.path", + "type": "string", + "label": "path", + "description": [ + "URL path to link to this future. Should not include the basePath." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L34" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.showOnHomePage", + "type": "boolean", + "label": "showOnHomePage", + "description": [ + "Whether or not this link should be shown on the front page of Kibana." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L36" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.order", + "type": "number", + "label": "order", + "description": [ + "An ordinal used to sort features relative to one another for display on the home page" + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L38" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.visible", + "type": "Function", + "label": "visible", + "description": [ + "Optional function to control visibility of this feature." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L40" + }, + "signature": [ + "(() => boolean) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueEntry.solutionId", + "type": "string", + "label": "solutionId", + "description": [ + "Unique string identifier of the solution this feature belongs to" + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L42" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FeatureCatalogueSolution", + "type": "Interface", + "label": "FeatureCatalogueSolution", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.id", + "type": "string", + "label": "id", + "description": [ + "Unique string identifier for this solution." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L48" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.title", + "type": "string", + "label": "title", + "description": [ + "Title of solution displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L50" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.subtitle", + "type": "string", + "label": "subtitle", + "description": [ + "The tagline of the solution displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L52" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.description", + "type": "string", + "label": "description", + "description": [ + "One-line description of the solution displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.appDescriptions", + "type": "Array", + "label": "appDescriptions", + "description": [ + "A list of use cases for this solution displayed to the user." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L56" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.icon", + "type": "CompoundType", + "label": "icon", + "description": [ + "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L58" + }, + "signature": [ + "IconType" + ] + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.path", + "type": "string", + "label": "path", + "description": [ + "URL path to link to this future. Should not include the basePath." + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L60" + } + }, + { + "tags": [], + "id": "def-public.FeatureCatalogueSolution.order", + "type": "number", + "label": "order", + "description": [ + "An ordinal used to sort solutions relative to one another for display on the home page" + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L62" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L46" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Environment", + "type": "Interface", + "label": "Environment", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.Environment.cloud", + "type": "boolean", + "label": "cloud", + "description": [ + "\nFlag whether the home app should advertise cloud features" + ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.Environment.apmUi", + "type": "boolean", + "label": "apmUi", + "description": [ + "\nFlag whether the home app should advertise apm features" + ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.Environment.ml", + "type": "boolean", + "label": "ml", + "description": [ + "\nFlag whether the home app should advertise ml features" + ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L22" + } + } + ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L10" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.FeatureCatalogueCategory", + "type": "Enum", + "label": "FeatureCatalogueCategory", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L13" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.FeatureCatalogueSetup", + "type": "Type", + "label": "FeatureCatalogueSetup", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L158" + }, + "signature": [ + "{ register: (feature: ", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueEntry", + "text": "FeatureCatalogueEntry" + }, + ") => void; registerSolution: (solution: ", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueSolution", + "text": "FeatureCatalogueSolution" + }, + ") => void; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.EnvironmentSetup", + "type": "Type", + "label": "EnvironmentSetup", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 161, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L161" + }, + "signature": [ + "{ update: (update: Partial<", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.Environment", + "text": "Environment" + }, + ">) => void; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TutorialSetup", + "type": "Type", + "label": "TutorialSetup", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 164, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L164" + }, + "signature": [ + "{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ", + "FC", + "<{}>) => void; registerDirectoryHeaderLink: (id: string, component: ", + "FC", + "<{}>) => void; registerModuleNotice: (id: string, component: ", + "FC", + "<{ moduleName: string; }>) => void; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TutorialVariables", + "type": "Type", + "label": "TutorialVariables", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L12" + }, + "signature": [ + "{ [x: string]: unknown; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TutorialDirectoryNoticeComponent", + "type": "Type", + "label": "TutorialDirectoryNoticeComponent", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L15" + }, + "signature": [ + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TutorialDirectoryHeaderLinkComponent", + "type": "Type", + "label": "TutorialDirectoryHeaderLinkComponent", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L18" + }, + "signature": [ + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + ], + "initialIsOpen": false + }, + { + "id": "def-public.TutorialModuleNoticeComponent", + "type": "Type", + "label": "TutorialModuleNoticeComponent", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L21" + }, + "signature": [ + "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.INSTRUCTION_VARIANT", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.ESC", + "type": "string", + "label": "ESC", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L10" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.OSX", + "type": "string", + "label": "OSX", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L11" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.DEB", + "type": "string", + "label": "DEB", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L12" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.RPM", + "type": "string", + "label": "RPM", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L13" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.DOCKER", + "type": "string", + "label": "DOCKER", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L14" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.WINDOWS", + "type": "string", + "label": "WINDOWS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L15" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.NODE", + "type": "string", + "label": "NODE", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L16" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.DJANGO", + "type": "string", + "label": "DJANGO", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L17" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.FLASK", + "type": "string", + "label": "FLASK", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L18" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.RAILS", + "type": "string", + "label": "RAILS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L19" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.RACK", + "type": "string", + "label": "RACK", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L20" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.JS", + "type": "string", + "label": "JS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L21" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.GO", + "type": "string", + "label": "GO", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L22" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.JAVA", + "type": "string", + "label": "JAVA", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L23" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.DOTNET", + "type": "string", + "label": "DOTNET", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.LINUX", + "type": "string", + "label": "LINUX", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L25" + } + }, + { + "tags": [], + "id": "def-public.INSTRUCTION_VARIANT.PHP", + "type": "string", + "label": "PHP", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L26" + } + } + ], + "description": [], + "label": "INSTRUCTION_VARIANT", + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L9" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-public.HomePublicPluginSetup", + "type": "Interface", + "label": "HomePublicPluginSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.HomePublicPluginSetup.tutorials", + "type": "Object", + "label": "tutorials", + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L168" + }, + "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; }" + ] + }, + { + "tags": [], + "id": "def-public.HomePublicPluginSetup.featureCatalogue", + "type": "Object", + "label": "featureCatalogue", + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 169, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L169" + }, + "signature": [ + "{ register: (feature: ", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueEntry", + "text": "FeatureCatalogueEntry" + }, + ") => void; registerSolution: (solution: ", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueSolution", + "text": "FeatureCatalogueSolution" + }, + ") => void; }" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L176" + }, + "signature": [ + "{ update: (update: Partial<", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.Environment", + "text": "Environment" + }, + ">) => void; }" + ] + } + ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L167" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.HomePublicPluginStart", + "type": "Interface", + "label": "HomePublicPluginStart", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.HomePublicPluginStart.featureCatalogue", + "type": "Object", + "label": "featureCatalogue", + "description": [], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 179, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L179" + }, + "signature": [ + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueRegistry", + "text": "FeatureCatalogueRegistry" + } + ] + } + ], + "source": { + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 178, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L178" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.ArtifactsSchema", + "type": "Interface", + "label": "ArtifactsSchema", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.ArtifactsSchema.exportedFields", + "type": "Object", + "label": "exportedFields", + "description": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L60" + }, + "signature": [ + "{ documentationUrl: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ArtifactsSchema.dashboards", + "type": "Array", + "label": "dashboards", + "description": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L63" + }, + "signature": [ + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.DashboardSchema", + "text": "DashboardSchema" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.ArtifactsSchema.application", + "type": "Object", + "label": "application", + "description": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L64" + }, + "signature": [ + "{ path: string; label: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L59" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-server.TutorialsCategory", + "type": "Enum", + "label": "TutorialsCategory", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L13" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-server.TutorialProvider", + "type": "Type", + "label": "TutorialProvider", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L100" + }, + "signature": [ + "(context: ", + "TutorialContext", + ") => ", + "TutorialSchema" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SampleDatasetProvider", + "type": "Type", + "label": "SampleDatasetProvider", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts#L82" + }, + "signature": [ + "() => ", + "SampleDatasetSchema", + "" + ], + "initialIsOpen": false + }, + { + "id": "def-server.SampleDataRegistrySetup", + "type": "Type", + "label": "SampleDataRegistrySetup", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts", + "lineNumber": 168, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/sample_data/sample_data_registry.ts#L168" + }, + "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; }" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-server.INSTRUCTION_VARIANT", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.ESC", + "type": "string", + "label": "ESC", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L10" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.OSX", + "type": "string", + "label": "OSX", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L11" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.DEB", + "type": "string", + "label": "DEB", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L12" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.RPM", + "type": "string", + "label": "RPM", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L13" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.DOCKER", + "type": "string", + "label": "DOCKER", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L14" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.WINDOWS", + "type": "string", + "label": "WINDOWS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L15" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.NODE", + "type": "string", + "label": "NODE", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L16" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.DJANGO", + "type": "string", + "label": "DJANGO", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L17" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.FLASK", + "type": "string", + "label": "FLASK", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L18" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.RAILS", + "type": "string", + "label": "RAILS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L19" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.RACK", + "type": "string", + "label": "RACK", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L20" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.JS", + "type": "string", + "label": "JS", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L21" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.GO", + "type": "string", + "label": "GO", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L22" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.JAVA", + "type": "string", + "label": "JAVA", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L23" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.DOTNET", + "type": "string", + "label": "DOTNET", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L24" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.LINUX", + "type": "string", + "label": "LINUX", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L25" + } + }, + { + "tags": [], + "id": "def-server.INSTRUCTION_VARIANT.PHP", + "type": "string", + "label": "PHP", + "description": [], + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L26" + } + } + ], + "description": [], + "label": "INSTRUCTION_VARIANT", + "source": { + "path": "src/plugins/home/common/instruction_variant.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L9" + }, + "initialIsOpen": false + } + ], + "setup": { + "id": "def-server.HomeServerPluginSetup", + "type": "Interface", + "label": "HomeServerPluginSetup", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HomeServerPluginSetup.tutorials", + "type": "Object", + "label": "tutorials", + "description": [], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L55" + }, + "signature": [ + "{ registerTutorial: (specProvider: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.TutorialProvider", + "text": "TutorialProvider" + }, + ") => void; unregisterTutorial: (specProvider: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.TutorialProvider", + "text": "TutorialProvider" + }, + ") => void; addScopedTutorialContextFactory: (scopedTutorialContextFactory: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.ScopedTutorialContextFactory", + "text": "ScopedTutorialContextFactory" + }, + ") => void; }" + ] + }, + { + "tags": [], + "id": "def-server.HomeServerPluginSetup.sampleData", + "type": "Object", + "label": "sampleData", + "description": [], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L56" + }, + "signature": [ + "{ registerSampleDataset: (specProvider: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.SampleDatasetProvider", + "text": "SampleDatasetProvider" + }, + ") => void; getSampleDatasets: () => ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.SampleDatasetSchema", + "text": "SampleDatasetSchema" + }, + "[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.AppLinkSchema", + "text": "AppLinkSchema" + }, + "[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", + { + "pluginId": "home", + "scope": "server", + "docId": "kibHomePluginApi", + "section": "def-server.SampleDatasetDashboardPanel", + "text": "SampleDatasetDashboardPanel" + } + ] + } + ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L54" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-server.HomeServerPluginStart", + "type": "Interface", + "label": "HomeServerPluginStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.HomeServerPluginStart.tutorials", + "type": "Object", + "label": "tutorials", + "description": [], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L61" + }, + "signature": [ + "{}" + ] + }, + { + "tags": [], + "id": "def-server.HomeServerPluginStart.sampleData", + "type": "Object", + "label": "sampleData", + "description": [], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L62" + }, + "signature": [ + "{}" + ] + } + ], + "source": { + "path": "src/plugins/home/server/plugin.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L60" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/home.mdx b/api_docs/home.mdx new file mode 100644 index 0000000000000..679aa7af236c6 --- /dev/null +++ b/api_docs/home.mdx @@ -0,0 +1,56 @@ +--- +id: kibHomePluginApi +slug: /kibana-dev-docs/homePluginApi +title: home +image: https://source.unsplash.com/400x175/?github +summary: API docs for the home plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import homeObj from './home.json'; + +## Client + +### Setup + + +### Start + + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Objects + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/index_lifecycle_management.json b/api_docs/index_lifecycle_management.json new file mode 100644 index 0000000000000..b65eeabefba20 --- /dev/null +++ b/api_docs/index_lifecycle_management.json @@ -0,0 +1,105 @@ +{ + "id": "indexLifecycleManagement", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-public.IlmUrlGeneratorState", + "type": "Interface", + "label": "IlmUrlGeneratorState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IlmUrlGeneratorState.page", + "type": "CompoundType", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L22" + }, + "signature": [ + "\"policies_list\" | \"policy_edit\" | \"policy_create\"" + ] + }, + { + "tags": [], + "id": "def-public.IlmUrlGeneratorState.policyName", + "type": "string", + "label": "policyName", + "description": [], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L23" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IlmUrlGeneratorState.absolute", + "type": "CompoundType", + "label": "absolute", + "description": [], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L24" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L21" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-public.ILM_URL_GENERATOR_ID", + "type": "string", + "label": "ILM_URL_GENERATOR_ID", + "description": [], + "source": { + "path": "x-pack/plugins/index_lifecycle_management/public/url_generator.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L19" + }, + "signature": [ + "\"ILM_URL_GENERATOR_ID\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx new file mode 100644 index 0000000000000..f6aff00be5c61 --- /dev/null +++ b/api_docs/index_lifecycle_management.mdx @@ -0,0 +1,21 @@ +--- +id: kibIndexLifecycleManagementPluginApi +slug: /kibana-dev-docs/indexLifecycleManagementPluginApi +title: indexLifecycleManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexLifecycleManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import indexLifecycleManagementObj from './index_lifecycle_management.json'; + +## Client + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/index_management.json b/api_docs/index_management.json new file mode 100644 index 0000000000000..28b1309c0bd9c --- /dev/null +++ b/api_docs/index_management.json @@ -0,0 +1,2607 @@ +{ + "id": "indexManagement", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.getIndexListUri", + "type": "Function", + "children": [ + { + "type": "string", + "label": "filter", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/public/application/services/routing.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38" + } + }, + { + "type": "CompoundType", + "label": "includeHiddenIndices", + "isRequired": false, + "signature": [ + "boolean | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/public/application/services/routing.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.IndexManagementPluginSetup", + "type": "Interface", + "label": "IndexManagementPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexManagementPluginSetup.extensionsService", + "type": "Object", + "label": "extensionsService", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/public/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/types.ts#L14" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "public", + "docId": "kibIndexManagementPluginApi", + "section": "def-public.ExtensionsSetup", + "text": "ExtensionsSetup" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/public/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/types.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Index", + "type": "Interface", + "label": "Index", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Index.health", + "type": "string", + "label": "health", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55" + } + }, + { + "tags": [], + "id": "def-public.Index.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56" + } + }, + { + "tags": [], + "id": "def-public.Index.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57" + } + }, + { + "tags": [], + "id": "def-public.Index.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58" + } + }, + { + "tags": [], + "id": "def-public.Index.primary", + "type": "string", + "label": "primary", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59" + } + }, + { + "tags": [], + "id": "def-public.Index.replica", + "type": "string", + "label": "replica", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60" + } + }, + { + "tags": [], + "id": "def-public.Index.documents", + "type": "Any", + "label": "documents", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.Index.size", + "type": "Any", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.Index.isFrozen", + "type": "boolean", + "label": "isFrozen", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63" + } + }, + { + "tags": [], + "id": "def-public.Index.aliases", + "type": "CompoundType", + "label": "aliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-public.Index.data_stream", + "type": "string", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-public.Index.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "id": "def-server.Dependencies", + "type": "Interface", + "label": "Dependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.Dependencies.security", + "type": "Object", + "label": "security", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L21" + }, + "signature": [ + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.SecurityPluginSetup", + "text": "SecurityPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.Dependencies.licensing", + "type": "Object", + "label": "licensing", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L22" + }, + "signature": [ + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingPluginSetup", + "text": "LicensingPluginSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.Dependencies.features", + "type": "Object", + "label": "features", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L23" + }, + "signature": [ + { + "pluginId": "features", + "scope": "server", + "docId": "kibFeaturesPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/server/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.Index", + "type": "Interface", + "label": "Index", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.Index.health", + "type": "string", + "label": "health", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55" + } + }, + { + "tags": [], + "id": "def-server.Index.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56" + } + }, + { + "tags": [], + "id": "def-server.Index.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57" + } + }, + { + "tags": [], + "id": "def-server.Index.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58" + } + }, + { + "tags": [], + "id": "def-server.Index.primary", + "type": "string", + "label": "primary", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59" + } + }, + { + "tags": [], + "id": "def-server.Index.replica", + "type": "string", + "label": "replica", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60" + } + }, + { + "tags": [], + "id": "def-server.Index.documents", + "type": "Any", + "label": "documents", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.Index.size", + "type": "Any", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.Index.isFrozen", + "type": "boolean", + "label": "isFrozen", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63" + } + }, + { + "tags": [], + "id": "def-server.Index.aliases", + "type": "CompoundType", + "label": "aliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-server.Index.data_stream", + "type": "string", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-server.Index.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyTemplateSerialized", + "type": "Interface", + "label": "LegacyTemplateSerialized", + "description": [ + "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.index_patterns", + "type": "Array", + "label": "index_patterns", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L100" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L101" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.settings", + "type": "Object", + "label": "settings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L102" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.IndexSettings", + "text": "IndexSettings" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.aliases", + "type": "Object", + "label": "aliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L103" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.mappings", + "type": "Object", + "label": "mappings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L104" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.LegacyTemplateSerialized.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L105" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L99" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.IndexManagementConfig", + "type": "Type", + "label": "IndexManagementConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/server/config.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/config.ts#L14" + }, + "signature": [ + "{ readonly enabled: boolean; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.IndexManagementPluginSetup", + "type": "Interface", + "label": "IndexManagementPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexManagementPluginSetup.indexDataEnricher", + "type": "Object", + "label": "indexDataEnricher", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/plugin.ts#L26" + }, + "signature": [ + "{ add: (enricher: ", + { + "pluginId": "indexManagement", + "scope": "server", + "docId": "kibIndexManagementPluginApi", + "section": "def-server.Enricher", + "text": "Enricher" + }, + ") => void; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/server/plugin.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/plugin.ts#L25" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "id": "def-common.getTemplateParameter", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "template", + "isRequired": true, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.LegacyTemplateSerialized", + "text": "LegacyTemplateSerialized" + }, + " | ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.TemplateSerialized", + "text": "TemplateSerialized" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/lib/utils.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L22" + } + }, + { + "type": "CompoundType", + "label": "setting", + "isRequired": true, + "signature": [ + "\"aliases\" | \"settings\" | \"mappings\"" + ], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/lib/utils.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L23" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L21" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.DataStreamFromEs", + "type": "Interface", + "label": "DataStreamFromEs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataStreamFromEs.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.timestamp_field", + "type": "Object", + "label": "timestamp_field", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L32" + }, + "signature": [ + "TimestampFieldFromEs" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.indices", + "type": "Array", + "label": "indices", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L33" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.DataStreamIndexFromEs", + "text": "DataStreamIndexFromEs" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.generation", + "type": "number", + "label": "generation", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L34" + } + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L35" + }, + "signature": [ + "MetaFromEs | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L36" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.HealthFromEs", + "text": "HealthFromEs" + } + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.template", + "type": "string", + "label": "template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L37" + } + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.ilm_policy", + "type": "string", + "label": "ilm_policy", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L38" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.store_size", + "type": "string", + "label": "store_size", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L39" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.store_size_bytes", + "type": "number", + "label": "store_size_bytes", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L40" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.maximum_timestamp", + "type": "number", + "label": "maximum_timestamp", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L41" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.privileges", + "type": "Object", + "label": "privileges", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L42" + }, + "signature": [ + "PrivilegesFromEs" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.hidden", + "type": "boolean", + "label": "hidden", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L43" + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DataStream", + "type": "Interface", + "label": "DataStream", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataStream.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L54" + } + }, + { + "tags": [], + "id": "def-common.DataStream.timeStampField", + "type": "Object", + "label": "timeStampField", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L55" + }, + "signature": [ + "TimestampFieldFromEs" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.indices", + "type": "Array", + "label": "indices", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L56" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.DataStreamIndex", + "text": "DataStreamIndex" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.generation", + "type": "number", + "label": "generation", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.DataStream.health", + "type": "CompoundType", + "label": "health", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L58" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Health", + "text": "Health" + } + ] + }, + { + "tags": [], + "id": "def-common.DataStream.indexTemplateName", + "type": "string", + "label": "indexTemplateName", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L59" + } + }, + { + "tags": [], + "id": "def-common.DataStream.ilmPolicyName", + "type": "string", + "label": "ilmPolicyName", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.storageSize", + "type": "string", + "label": "storageSize", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L61" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.storageSizeBytes", + "type": "number", + "label": "storageSizeBytes", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L62" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.maxTimeStamp", + "type": "number", + "label": "maxTimeStamp", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L63" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStream._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L64" + }, + "signature": [ + "MetaFromEs | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.privileges", + "type": "Object", + "label": "privileges", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L65" + }, + "signature": [ + "PrivilegesFromEs" + ] + }, + { + "tags": [], + "id": "def-common.DataStream.hidden", + "type": "boolean", + "label": "hidden", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L66" + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-common.DataStreamIndex", + "type": "Interface", + "label": "DataStreamIndex", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataStreamIndex.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 70, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L70" + } + }, + { + "tags": [], + "id": "def-common.DataStreamIndex.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L71" + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L69" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Aliases", + "type": "Interface", + "label": "Aliases", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.Aliases.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/aliases.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/aliases.ts#L9" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/aliases.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/aliases.ts#L8" + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexSettings", + "type": "Interface", + "label": "IndexSettings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IndexSettings.index", + "type": "Object", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L49" + }, + "signature": [ + "Partial | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexSettings.analysis", + "type": "Object", + "label": "analysis", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L50" + }, + "signature": [ + "AnalysisModule | undefined" + ] + }, + { + "id": "def-common.IndexSettings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L51" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Index", + "type": "Interface", + "label": "Index", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Index.health", + "type": "string", + "label": "health", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55" + } + }, + { + "tags": [], + "id": "def-common.Index.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56" + } + }, + { + "tags": [], + "id": "def-common.Index.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57" + } + }, + { + "tags": [], + "id": "def-common.Index.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 58, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58" + } + }, + { + "tags": [], + "id": "def-common.Index.primary", + "type": "string", + "label": "primary", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59" + } + }, + { + "tags": [], + "id": "def-common.Index.replica", + "type": "string", + "label": "replica", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60" + } + }, + { + "tags": [], + "id": "def-common.Index.documents", + "type": "Any", + "label": "documents", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.Index.size", + "type": "Any", + "label": "size", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62" + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.Index.isFrozen", + "type": "boolean", + "label": "isFrozen", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63" + } + }, + { + "tags": [], + "id": "def-common.Index.aliases", + "type": "CompoundType", + "label": "aliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64" + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-common.Index.data_stream", + "type": "string", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65" + }, + "signature": [ + "string | undefined" + ] + }, + { + "id": "def-common.Index.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-common.Mappings", + "type": "Interface", + "label": "Mappings", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.Mappings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/mappings.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/mappings.ts#L11" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/mappings.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/mappings.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TemplateSerialized", + "type": "Interface", + "label": "TemplateSerialized", + "description": [ + "\nIndex template format from Elasticsearch" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TemplateSerialized.index_patterns", + "type": "Array", + "label": "index_patterns", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L16" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized.template", + "type": "Object", + "label": "template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L17" + }, + "signature": [ + "{ settings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.IndexSettings", + "text": "IndexSettings" + }, + " | undefined; aliases?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined; mappings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized.composed_of", + "type": "Array", + "label": "composed_of", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L22" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L23" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized.priority", + "type": "number", + "label": "priority", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L24" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L25" + }, + "signature": [ + "{ [key: string]: any; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateSerialized.data_stream", + "type": "Object", + "label": "data_stream", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L26" + }, + "signature": [ + "{} | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L15" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TemplateDeserialized", + "type": "Interface", + "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": [], + "children": [ + { + "tags": [], + "id": "def-common.TemplateDeserialized.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L35" + } + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.indexPatterns", + "type": "Array", + "label": "indexPatterns", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L36" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.template", + "type": "Object", + "label": "template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L37" + }, + "signature": [ + "{ settings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.IndexSettings", + "text": "IndexSettings" + }, + " | undefined; aliases?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined; mappings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.composedOf", + "type": "Array", + "label": "composedOf", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L42" + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L43" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.priority", + "type": "number", + "label": "priority", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L44" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L45" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.ilmPolicy", + "type": "Object", + "label": "ilmPolicy", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L46" + }, + "signature": [ + "{ name: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L49" + }, + "signature": [ + "{ [key: string]: any; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized.dataStream", + "type": "Object", + "label": "dataStream", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L51" + }, + "signature": [ + "{ [key: string]: any; hidden?: boolean | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateDeserialized._kbnMeta", + "type": "Object", + "label": "_kbnMeta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L55" + }, + "signature": [ + "{ type: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.TemplateType", + "text": "TemplateType" + }, + "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L34" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TemplateFromEs", + "type": "Interface", + "label": "TemplateFromEs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.TemplateFromEs.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L65" + } + }, + { + "tags": [], + "id": "def-common.TemplateFromEs.index_template", + "type": "Object", + "label": "index_template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L66" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.TemplateSerialized", + "text": "TemplateSerialized" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L64" + }, + "initialIsOpen": false + }, + { + "id": "def-common.TemplateListItem", + "type": "Interface", + "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": [], + "children": [ + { + "tags": [], + "id": "def-common.TemplateListItem.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L75" + } + }, + { + "tags": [], + "id": "def-common.TemplateListItem.indexPatterns", + "type": "Array", + "label": "indexPatterns", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L76" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.TemplateListItem.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L77" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateListItem.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L78" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateListItem.priority", + "type": "number", + "label": "priority", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L79" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateListItem.hasSettings", + "type": "boolean", + "label": "hasSettings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L80" + } + }, + { + "tags": [], + "id": "def-common.TemplateListItem.hasAliases", + "type": "boolean", + "label": "hasAliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L81" + } + }, + { + "tags": [], + "id": "def-common.TemplateListItem.hasMappings", + "type": "boolean", + "label": "hasMappings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L82" + } + }, + { + "tags": [], + "id": "def-common.TemplateListItem.ilmPolicy", + "type": "Object", + "label": "ilmPolicy", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L83" + }, + "signature": [ + "{ name: string; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.TemplateListItem._kbnMeta", + "type": "Object", + "label": "_kbnMeta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L86" + }, + "signature": [ + "{ type: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.TemplateType", + "text": "TemplateType" + }, + "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L74" + }, + "initialIsOpen": false + }, + { + "id": "def-common.LegacyTemplateSerialized", + "type": "Interface", + "label": "LegacyTemplateSerialized", + "description": [ + "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.index_patterns", + "type": "Array", + "label": "index_patterns", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 100, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L100" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L101" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.settings", + "type": "Object", + "label": "settings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L102" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.IndexSettings", + "text": "IndexSettings" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.aliases", + "type": "Object", + "label": "aliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L103" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.mappings", + "type": "Object", + "label": "mappings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L104" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L105" + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L99" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateSerialized", + "type": "Interface", + "label": "ComponentTemplateSerialized", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateSerialized.template", + "type": "Object", + "label": "template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L13" + }, + "signature": [ + "{ settings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.IndexSettings", + "text": "IndexSettings" + }, + " | undefined; aliases?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined; mappings?: ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined; }" + ] + }, + { + "tags": [], + "id": "def-common.ComponentTemplateSerialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L18" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ComponentTemplateSerialized._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L19" + }, + "signature": [ + "{ [key: string]: any; } | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateDeserialized", + "type": "Interface", + "label": "ComponentTemplateDeserialized", + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.ComponentTemplateDeserialized", + "text": "ComponentTemplateDeserialized" + }, + " extends ", + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.ComponentTemplateSerialized", + "text": "ComponentTemplateSerialized" + } + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateDeserialized.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L23" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateDeserialized._kbnMeta", + "type": "Object", + "label": "_kbnMeta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L24" + }, + "signature": [ + "{ usedBy: string[]; isManaged: boolean; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateFromEs", + "type": "Interface", + "label": "ComponentTemplateFromEs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateFromEs.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L31" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateFromEs.component_template", + "type": "Object", + "label": "component_template", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L32" + }, + "signature": [ + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.ComponentTemplateSerialized", + "text": "ComponentTemplateSerialized" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateListItem", + "type": "Interface", + "label": "ComponentTemplateListItem", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L36" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.usedBy", + "type": "Array", + "label": "usedBy", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L37" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.hasMappings", + "type": "boolean", + "label": "hasMappings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L38" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.hasAliases", + "type": "boolean", + "label": "hasAliases", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L39" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.hasSettings", + "type": "boolean", + "label": "hasSettings", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L40" + } + }, + { + "tags": [], + "id": "def-common.ComponentTemplateListItem.isManaged", + "type": "boolean", + "label": "isManaged", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L41" + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L35" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "tags": [], + "id": "def-common.API_BASE_PATH", + "type": "string", + "label": "API_BASE_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/constants/api_base_path.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/constants/api_base_path.ts#L8" + }, + "signature": [ + "\"/api/index_management\"" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.BASE_PATH", + "type": "string", + "label": "BASE_PATH", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/constants/base_path.ts", + "lineNumber": 8, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/constants/base_path.ts#L8" + }, + "signature": [ + "\"/management/data/index_management/\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.Health", + "type": "Type", + "label": "Health", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L51" + }, + "signature": [ + "\"green\" | \"yellow\" | \"red\"" + ], + "initialIsOpen": false + }, + { + "id": "def-common.TemplateType", + "type": "Type", + "label": "TemplateType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L62" + }, + "signature": [ + "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx new file mode 100644 index 0000000000000..0f22d279f7ecf --- /dev/null +++ b/api_docs/index_management.mdx @@ -0,0 +1,43 @@ +--- +id: kibIndexManagementPluginApi +slug: /kibana-dev-docs/indexManagementPluginApi +title: indexManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import indexManagementObj from './index_management.json'; + +## Client + +### Functions + + +### Interfaces + + +## Server + +### Setup + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json new file mode 100644 index 0000000000000..aafb91d89df27 --- /dev/null +++ b/api_docs/index_pattern_field_editor.json @@ -0,0 +1,497 @@ +{ + "id": "indexPatternFieldEditor", + "client": { + "classes": [ + { + "id": "def-public.DefaultFormatEditor", + "type": "Class", + "tags": [], + "label": "DefaultFormatEditor", + "description": [], + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.DefaultFormatEditor", + "text": "DefaultFormatEditor" + }, + " extends React.PureComponent<", + "FormatEditorProps", + "

, ", + "FormatEditorState", + " & S, any>" + ], + "children": [ + { + "tags": [], + "id": "def-public.DefaultFormatEditor.formatId", + "type": "string", + "label": "formatId", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L77" + } + }, + { + "tags": [], + "id": "def-public.DefaultFormatEditor.state", + "type": "CompoundType", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78" + }, + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + }, + " & S" + ] + }, + { + "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps", + "type": "Function", + "label": "getDerivedStateFromProps", + "signature": [ + "typeof ", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.DefaultFormatEditor", + "text": "DefaultFormatEditor" + }, + ".getDerivedStateFromProps" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "nextProps", + "isRequired": true, + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.FormatEditorProps", + "text": "FormatEditorProps" + }, + "<{}>" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80" + } + }, + { + "type": "Object", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80" + } + }, + { + "id": "def-public.DefaultFormatEditor.onChange", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "newParams", + "isRequired": true, + "signature": [ + "{}" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92" + } + } + ], + "signature": [ + "(newParams?: {}) => void" + ], + "description": [], + "label": "onChange", + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.DefaultFormatEditor.render", + "type": "Function", + "label": "render", + "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": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L101" + } + } + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L73" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.OpenFieldEditorOptions", + "type": "Interface", + "label": "OpenFieldEditorOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.OpenFieldEditorOptions.ctx", + "type": "Object", + "label": "ctx", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L28" + }, + "signature": [ + "{ indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + "; }" + ] + }, + { + "tags": [], + "id": "def-public.OpenFieldEditorOptions.onSave", + "type": "Function", + "label": "onSave", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L31" + }, + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.OpenFieldEditorOptions.fieldName", + "type": "string", + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L32" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L27" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldEditorContext", + "type": "Interface", + "label": "FieldEditorContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FieldEditorContext.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L28" + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ] + }, + { + "tags": [], + "id": "def-public.FieldEditorContext.fieldTypeToProcess", + "type": "CompoundType", + "label": "fieldTypeToProcess", + "description": [ + "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L33" + }, + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.InternalFieldType", + "text": "InternalFieldType" + } + ] + }, + { + "tags": [], + "id": "def-public.FieldEditorContext.search", + "type": "Object", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L35" + }, + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchStart", + "text": "ISearchStart" + } + ] + } + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L27" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "start": { + "id": "def-public.PluginStart", + "type": "Interface", + "label": "PluginStart", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.PluginStart.openEditor", + "type": "Function", + "label": "openEditor", + "signature": [ + "(options: ", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.OpenFieldEditorOptions", + "text": "OpenFieldEditorOptions" + }, + ") => () => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.OpenFieldEditorOptions", + "text": "OpenFieldEditorOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26" + } + }, + { + "tags": [], + "id": "def-public.PluginStart.fieldFormatEditors", + "type": "Object", + "label": "fieldFormatEditors", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L27" + }, + "signature": [ + "{ getAll: () => typeof ", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.DefaultFormatEditor", + "text": "DefaultFormatEditor" + }, + "[]; getById: (id: string) => typeof ", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.DefaultFormatEditor", + "text": "DefaultFormatEditor" + }, + " | undefined; }" + ] + }, + { + "tags": [], + "id": "def-public.PluginStart.userPermissions", + "type": "Object", + "label": "userPermissions", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L28" + }, + "signature": [ + "{ editIndexPattern: () => boolean; }" + ] + }, + { + "tags": [], + "id": "def-public.PluginStart.DeleteRuntimeFieldProvider", + "type": "Function", + "label": "DeleteRuntimeFieldProvider", + "description": [], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L31" + }, + "signature": [ + "React.FunctionComponent<", + { + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.Props", + "text": "Props" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/index_pattern_field_editor/public/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L25" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/index_pattern_field_editor.mdx b/api_docs/index_pattern_field_editor.mdx new file mode 100644 index 0000000000000..7c057e8706f7d --- /dev/null +++ b/api_docs/index_pattern_field_editor.mdx @@ -0,0 +1,24 @@ +--- +id: kibIndexPatternFieldEditorPluginApi +slug: /kibana-dev-docs/indexPatternFieldEditorPluginApi +title: indexPatternFieldEditor +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexPatternFieldEditor plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternFieldEditor'] +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 indexPatternFieldEditorObj from './index_pattern_field_editor.json'; + +## Client + +### Start + + +### Classes + + +### Interfaces + + diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json new file mode 100644 index 0000000000000..50e37fec7ad65 --- /dev/null +++ b/api_docs/index_pattern_management.json @@ -0,0 +1,914 @@ +{ + "id": "indexPatternManagement", + "client": { + "classes": [ + { + "id": "def-public.IndexPatternCreationConfig", + "type": "Class", + "tags": [], + "label": "IndexPatternCreationConfig", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.key", + "type": "string", + "label": "key", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L38" + }, + "signature": [ + "\"default\"" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L40" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L41" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.showSystemIndices", + "type": "boolean", + "label": "showSystemIndices", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L42" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.httpClient", + "type": "CompoundType", + "label": "httpClient", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L43" + }, + "signature": [ + "object | null" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.isBeta", + "type": "boolean", + "label": "isBeta", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L44" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", + "type": "Object", + "label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L53" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L54" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.showSystemIndices", + "type": "CompoundType", + "label": "showSystemIndices", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L55" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.httpClient", + "type": "CompoundType", + "label": "httpClient", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L56" + }, + "signature": [ + "object | null | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.isBeta", + "type": "CompoundType", + "label": "isBeta", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L57" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L52" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L46" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption", + "type": "Function", + "label": "getIndexPatternCreationOption", + "signature": [ + "(urlHandler: ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.UrlHandler", + "text": "UrlHandler" + }, + ") => ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternCreationOption", + "text": "IndexPatternCreationOption" + } + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "urlHandler", + "isRequired": true, + "signature": [ + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.UrlHandler", + "text": "UrlHandler" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIndexPatternType", + "type": "Function", + "label": "getIndexPatternType", + "signature": [ + "() => string | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L77" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIndexPatternName", + "type": "Function", + "label": "getIndexPatternName", + "signature": [ + "() => string" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L81" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIsBeta", + "type": "Function", + "label": "getIsBeta", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 85, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L85" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getShowSystemIndices", + "type": "Function", + "label": "getShowSystemIndices", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 89, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L89" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIndexTags", + "type": "Function", + "label": "getIndexTags", + "signature": [ + "(indexName: string) => never[]" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "indexName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors", + "type": "Function", + "label": "checkIndicesForErrors", + "signature": [ + "(indices: ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.MatchedItem", + "text": "MatchedItem" + }, + "[]) => undefined" + ], + "description": [], + "children": [ + { + "type": "Array", + "label": "indices", + "isRequired": true, + "signature": [ + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.MatchedItem", + "text": "MatchedItem" + }, + "[]" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 97, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getIndexPatternMappings", + "type": "Function", + "label": "getIndexPatternMappings", + "signature": [ + "() => {}" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L101" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.renderPrompt", + "type": "Function", + "label": "renderPrompt", + "signature": [ + "() => null" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 105, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L105" + } + }, + { + "id": "def-public.IndexPatternCreationConfig.getFetchForWildcardOptions", + "type": "Function", + "label": "getFetchForWildcardOptions", + "signature": [ + "() => {}" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L109" + } + } + ], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L37" + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternListConfig", + "type": "Class", + "tags": [], + "label": "IndexPatternListConfig", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternListConfig.key", + "type": "string", + "label": "key", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L26" + }, + "signature": [ + "\"default\"" + ] + }, + { + "id": "def-public.IndexPatternListConfig.getIndexPatternTags", + "type": "Function", + "label": "getIndexPatternTags", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ">, isDefault: boolean) => ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternTag", + "text": "IndexPatternTag" + }, + "[]" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L29" + } + }, + { + "type": "boolean", + "label": "isDefault", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L30" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L28" + } + }, + { + "id": "def-public.IndexPatternListConfig.getFieldInfo", + "type": "Function", + "label": "getFieldInfo", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => string[]" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42" + } + }, + { + "type": "Object", + "label": "field", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42" + } + }, + { + "id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled", + "type": "Function", + "label": "areScriptedFieldsEnabled", + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ") => boolean" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "indexPattern", + "isRequired": true, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46" + } + } + ], + "source": { + "path": "src/plugins/index_pattern_management/public/service/list/config.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L25" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.IndexPatternCreationOption", + "type": "Interface", + "label": "IndexPatternCreationOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternCreationOption.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L30" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationOption.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L31" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationOption.testSubj", + "type": "string", + "label": "testSubj", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L32" + } + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationOption.onClick", + "type": "Function", + "label": "onClick", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L33" + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternCreationOption.isBeta", + "type": "CompoundType", + "label": "isBeta", + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L34" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/index_pattern_management/public/service/creation/config.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L29" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.MlCardState", + "type": "Enum", + "label": "MlCardState", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/types.ts#L42" + }, + "initialIsOpen": false + } + ], + "misc": [], + "objects": [], + "setup": { + "id": "def-public.IndexPatternManagementSetup", + "type": "Type", + "label": "IndexPatternManagementSetup", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/plugin.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L32" + }, + "signature": [ + "{ creation: { addCreationConfig: (Config: typeof ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternCreationConfig", + "text": "IndexPatternCreationConfig" + }, + ") => void; }; list: { addListConfig: (Config: typeof ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternListConfig", + "text": "IndexPatternListConfig" + }, + ") => void; }; environment: { update: (update: Partial<", + "Environment", + ">) => void; }; }" + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.IndexPatternManagementStart", + "type": "Type", + "label": "IndexPatternManagementStart", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/index_pattern_management/public/plugin.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L34" + }, + "signature": [ + "{ creation: { getType: (key: string | undefined) => ", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternCreationConfig", + "text": "IndexPatternCreationConfig" + }, + "; getIndexPatternCreationOptions: (urlHandler: ", + "UrlHandler", + ") => Promise<", + { + "pluginId": "indexPatternManagement", + "scope": "public", + "docId": "kibIndexPatternManagementPluginApi", + "section": "def-public.IndexPatternCreationOption", + "text": "IndexPatternCreationOption" + }, + "[]>; }; list: { getIndexPatternTags: (indexPattern: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.IIndexPattern", + "text": "IIndexPattern" + }, + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/index_pattern_management.mdx b/api_docs/index_pattern_management.mdx new file mode 100644 index 0000000000000..b74d3a7262870 --- /dev/null +++ b/api_docs/index_pattern_management.mdx @@ -0,0 +1,30 @@ +--- +id: kibIndexPatternManagementPluginApi +slug: /kibana-dev-docs/indexPatternManagementPluginApi +title: indexPatternManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexPatternManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternManagement'] +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 indexPatternManagementObj from './index_pattern_management.json'; + +## Client + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + +### Enums + + diff --git a/api_docs/infra.json b/api_docs/infra.json new file mode 100644 index 0000000000000..88b628bbfaef8 --- /dev/null +++ b/api_docs/infra.json @@ -0,0 +1,270 @@ +{ + "id": "infra", + "client": { + "classes": [], + "functions": [ + { + "id": "def-public.LazyLogStreamWrapper", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "props", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "infra", + "scope": "public", + "docId": "kibInfraPluginApi", + "section": "def-public.LogStreamProps", + "text": "LogStreamProps" + }, + ">" + ], + "description": [], + "source": { + "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [ + { + "id": "def-public.InfraFormatterType", + "type": "Enum", + "label": "InfraFormatterType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/infra/public/lib/lib.ts", + "lineNumber": 147, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/lib/lib.ts#L147" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.InfraAppId", + "type": "Type", + "label": "InfraAppId", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/infra/public/index.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/index.ts#L29" + }, + "signature": [ + "\"metrics\" | \"logs\"" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "id": "def-public.FORMATTERS", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FORMATTERS.number", + "type": "Function", + "label": "number", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L16" + }, + "signature": [ + "(val: number) => string" + ] + }, + { + "tags": [], + "id": "def-public.FORMATTERS.abbreviatedNumber", + "type": "Function", + "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." + ], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L19" + }, + "signature": [ + "(bytes: number) => string" + ] + }, + { + "tags": [], + "id": "def-public.FORMATTERS.bytes", + "type": "Function", + "label": "bytes", + "description": [ + "// bytes in bytes formatted string out" + ], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L21" + }, + "signature": [ + "(bytes: number) => string" + ] + }, + { + "tags": [], + "id": "def-public.FORMATTERS.bits", + "type": "Function", + "label": "bits", + "description": [ + "// bytes in bits formatted string out" + ], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L23" + }, + "signature": [ + "(bytes: number) => string" + ] + }, + { + "tags": [], + "id": "def-public.FORMATTERS.percent", + "type": "Function", + "label": "percent", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L24" + }, + "signature": [ + "(val: number) => string" + ] + }, + { + "tags": [], + "id": "def-public.FORMATTERS.highPercision", + "type": "Function", + "label": "highPercision", + "description": [], + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L25" + }, + "signature": [ + "(val: number) => string" + ] + } + ], + "description": [], + "label": "FORMATTERS", + "source": { + "path": "x-pack/plugins/infra/common/formatters/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L15" + }, + "initialIsOpen": false + } + ] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "id": "def-server.InfraConfig", + "type": "Type", + "label": "InfraConfig", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L64" + }, + "signature": [ + "{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; container?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly query: Readonly<{} & { partitionSize: number; partitionFactor: number; }>; }" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-server.InfraPluginSetup", + "type": "Interface", + "label": "InfraPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration", + "type": "Function", + "label": "defineInternalSourceConfiguration", + "description": [], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L75" + }, + "signature": [ + "(sourceId: string, sourceProperties: ", + { + "pluginId": "infra", + "scope": "common", + "docId": "kibInfraPluginApi", + "section": "def-common.InfraStaticSourceConfiguration", + "text": "InfraStaticSourceConfiguration" + }, + ") => void" + ] + } + ], + "source": { + "path": "x-pack/plugins/infra/server/plugin.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L74" + }, + "lifecycle": "setup", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx new file mode 100644 index 0000000000000..83eb998262864 --- /dev/null +++ b/api_docs/infra.mdx @@ -0,0 +1,35 @@ +--- +id: kibInfraPluginApi +slug: /kibana-dev-docs/infraPluginApi +title: infra +image: https://source.unsplash.com/400x175/?github +summary: API docs for the infra plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import infraObj from './infra.json'; + +## Client + +### Objects + + +### Functions + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Consts, variables and types + + diff --git a/api_docs/ingest_pipelines.json b/api_docs/ingest_pipelines.json new file mode 100644 index 0000000000000..8bc2770d5b94a --- /dev/null +++ b/api_docs/ingest_pipelines.json @@ -0,0 +1,207 @@ +{ + "id": "ingestPipelines", + "client": { + "classes": [ + { + "id": "def-public.IngestPipelinesUrlGenerator", + "type": "Class", + "tags": [], + "label": "IngestPipelinesUrlGenerator", + "description": [], + "signature": [ + { + "pluginId": "ingestPipelines", + "scope": "public", + "docId": "kibIngestPipelinesPluginApi", + "section": "def-public.IngestPipelinesUrlGenerator", + "text": "IngestPipelinesUrlGenerator" + }, + " implements ", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorsDefinition", + "text": "UrlGeneratorsDefinition" + }, + "<\"INGEST_PIPELINES_APP_URL_GENERATOR\">" + ], + "children": [ + { + "id": "def-public.IngestPipelinesUrlGenerator.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "getAppBasePath", + "isRequired": true, + "signature": [ + "(absolute: boolean) => Promise" + ], + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57" + } + }, + { + "tags": [], + "id": "def-public.IngestPipelinesUrlGenerator.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L59" + }, + "signature": [ + "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" + ] + }, + { + "id": "def-public.IngestPipelinesUrlGenerator.createUrl", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "state", + "isRequired": true, + "signature": [ + { + "pluginId": "ingestPipelines", + "scope": "public", + "docId": "kibIngestPipelinesPluginApi", + "section": "def-public.IngestPipelinesUrlGeneratorState", + "text": "IngestPipelinesUrlGeneratorState" + } + ], + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L55" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [ + { + "id": "def-public.INGEST_PIPELINES_PAGES", + "type": "Enum", + "label": "INGEST_PIPELINES_PAGES", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L22" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "tags": [], + "id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR", + "type": "string", + "label": "INGEST_PIPELINES_APP_ULR_GENERATOR", + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L20" + }, + "signature": [ + "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IngestPipelinesUrlGeneratorState", + "type": "Type", + "label": "IngestPipelinesUrlGeneratorState", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L49" + }, + "signature": [ + "PipelinesListUrlGeneratorState", + " | ", + "PipelineEditUrlGeneratorState", + " | ", + "PipelineCloneUrlGeneratorState", + " | ", + "PipelineCreateUrlGeneratorState" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/ingest_pipelines.mdx b/api_docs/ingest_pipelines.mdx new file mode 100644 index 0000000000000..eb56280c5b4ae --- /dev/null +++ b/api_docs/ingest_pipelines.mdx @@ -0,0 +1,24 @@ +--- +id: kibIngestPipelinesPluginApi +slug: /kibana-dev-docs/ingestPipelinesPluginApi +title: ingestPipelines +image: https://source.unsplash.com/400x175/?github +summary: API docs for the ingestPipelines plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines'] +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 ingestPipelinesObj from './ingest_pipelines.json'; + +## Client + +### Classes + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/inspector.json b/api_docs/inspector.json new file mode 100644 index 0000000000000..55132039eda18 --- /dev/null +++ b/api_docs/inspector.json @@ -0,0 +1,2061 @@ +{ + "id": "inspector", + "client": { + "classes": [ + { + "id": "def-public.InspectorPublicPlugin", + "type": "Class", + "tags": [], + "label": "InspectorPublicPlugin", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorPublicPlugin", + "text": "InspectorPublicPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Setup", + "text": "Setup" + }, + ", ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Start", + "text": "Start" + }, + ", object, object>" + ], + "children": [ + { + "tags": [], + "id": "def-public.InspectorPublicPlugin.views", + "type": "Object", + "label": "views", + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L55" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewRegistry", + "text": "InspectorViewRegistry" + }, + " | undefined" + ] + }, + { + "id": "def-public.InspectorPublicPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L57" + } + }, + { + "id": "def-public.InspectorPublicPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ") => { registerView: (view: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewDescription", + "text": "InspectorViewDescription" + }, + ") => void; __LEGACY: { views: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewRegistry", + "text": "InspectorViewRegistry" + }, + "; }; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L59" + } + }, + { + "id": "def-public.InspectorPublicPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => { isAvailable: (adapters?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined) => boolean; open: (adapters: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", options?: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorOptions", + "text": "InspectorOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L73" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L73" + } + }, + { + "id": "def-public.InspectorPublicPlugin.stop", + "type": "Function", + "label": "stop", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L114" + } + } + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L54" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RequestAdapter", + "type": "Class", + "tags": [ + "extends" + ], + "label": "RequestAdapter", + "description": [ + "\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind." + ], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-public.RequestAdapter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L24" + } + }, + { + "id": "def-public.RequestAdapter.start", + "type": "Function", + "label": "start", + "signature": [ + "(name: string, params?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestParams", + "text": "RequestParams" + }, + ") => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "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" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "The name of this request as it should be shown in the UI." + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestParams", + "text": "RequestParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + }, + { + "id": "def-public.RequestAdapter.reset", + "type": "Function", + "label": "reset", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L52" + } + }, + { + "id": "def-public.RequestAdapter.resetRequest", + "type": "Function", + "label": "resetRequest", + "signature": [ + "(id: string) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57" + } + }, + { + "id": "def-public.RequestAdapter.getRequests", + "type": "Function", + "label": "getRequests", + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Request", + "text": "Request" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L62" + } + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RequestResponder", + "type": "Class", + "tags": [], + "label": "RequestResponder", + "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}." + ], + "children": [ + { + "id": "def-public.RequestResponder.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Request", + "text": "Request" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + }, + { + "type": "Function", + "label": "onChange", + "isRequired": true, + "signature": [ + "() => void" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + }, + { + "id": "def-public.RequestResponder.json", + "type": "Function", + "label": "json", + "signature": [ + "(reqJson: object) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "text": "RequestResponder" + } + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "reqJson", + "isRequired": true, + "signature": [ + "object" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25" + } + }, + { + "id": "def-public.RequestResponder.stats", + "type": "Function", + "label": "stats", + "signature": [ + "(stats: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + }, + ") => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "text": "RequestResponder" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "stats", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31" + } + }, + { + "id": "def-public.RequestResponder.finish", + "type": "Function", + "label": "finish", + "signature": [ + "(status: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatus", + "text": "RequestStatus" + }, + ", response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Enum", + "label": "status", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatus", + "text": "RequestStatus" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + }, + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + }, + { + "id": "def-public.RequestResponder.ok", + "type": "Function", + "label": "ok", + "signature": [ + "(response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60" + } + }, + { + "id": "def-public.RequestResponder.error", + "type": "Function", + "label": "error", + "signature": [ + "(response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64" + } + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L16" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-public.InspectorViewProps", + "type": "Interface", + "label": "InspectorViewProps", + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewProps", + "text": "InspectorViewProps" + }, + "" + ], + "description": [ + "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.InspectorViewProps.adapters", + "type": "Uncategorized", + "label": "adapters", + "description": [ + "\nAdapters used to open the inspector." + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L20" + }, + "signature": [ + "TAdapters" + ] + }, + { + "tags": [], + "id": "def-public.InspectorViewProps.title", + "type": "string", + "label": "title", + "description": [ + "\nThe title that the inspector is currently using e.g. a visualization name." + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L24" + } + }, + { + "tags": [], + "id": "def-public.InspectorViewProps.options", + "type": "Unknown", + "label": "options", + "description": [ + "\nA set of specific options for each view." + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L28" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.InspectorViewDescription", + "type": "Interface", + "label": "InspectorViewDescription", + "description": [ + "\nAn object describing an inspector view." + ], + "tags": [ + "typedef" + ], + "children": [ + { + "tags": [], + "id": "def-public.InspectorViewDescription.component", + "type": "CompoundType", + "label": "component", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L46" + }, + "signature": [ + "React.ComponentType<", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewProps", + "text": "InspectorViewProps" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ">>" + ] + }, + { + "tags": [], + "id": "def-public.InspectorViewDescription.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L47" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.InspectorViewDescription.order", + "type": "number", + "label": "order", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L48" + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.InspectorViewDescription.shouldShow", + "type": "Function", + "label": "shouldShow", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L49" + }, + "signature": [ + "((adapters: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ") => boolean) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.InspectorViewDescription.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L50" + } + } + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-public.InspectorOptions", + "type": "Interface", + "label": "InspectorOptions", + "description": [ + "\nOptions that can be specified when opening the inspector." + ], + "tags": [ + "property", + "property" + ], + "children": [ + { + "tags": [], + "id": "def-public.InspectorOptions.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L60" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.InspectorOptions.options", + "type": "Unknown", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L61" + }, + "signature": [ + "unknown" + ] + } + ], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L59" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RequestStatistic", + "type": "Interface", + "label": "RequestStatistic", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RequestStatistic.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L49" + } + }, + { + "tags": [], + "id": "def-public.RequestStatistic.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L50" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RequestStatistic.value", + "type": "Any", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L51" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-public.RequestStatistics", + "type": "Interface", + "label": "RequestStatistics", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.RequestStatistics.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L45" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L44" + }, + "initialIsOpen": false + }, + { + "id": "def-public.Adapters", + "type": "Interface", + "label": "Adapters", + "description": [ + "\nThe interface that the adapters used to open an inspector have to fullfill." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Adapters.requests", + "type": "Object", + "label": "requests", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ] + }, + { + "id": "def-public.Adapters.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-public.RequestStatus", + "type": "Enum", + "label": "RequestStatus", + "tags": [], + "description": [ + "\nThe status a request can have." + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L12" + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.InspectorSession", + "type": "Type", + "label": "InspectorSession", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/public/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L64" + }, + "signature": [ + "OverlayRef" + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "id": "def-public.Setup", + "type": "Interface", + "label": "Setup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Setup.registerView", + "type": "Function", + "label": "registerView", + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L21" + }, + "signature": [ + "(view: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewDescription", + "text": "InspectorViewDescription" + }, + ") => void" + ] + }, + { + "tags": [], + "id": "def-public.Setup.__LEGACY", + "type": "Object", + "label": "__LEGACY", + "description": [], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L23" + }, + "signature": [ + "{ views: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewRegistry", + "text": "InspectorViewRegistry" + }, + "; }" + ] + } + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L20" + }, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "id": "def-public.Start", + "type": "Interface", + "label": "Start", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Start.isAvailable", + "type": "Function", + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L37" + }, + "signature": [ + "(adapters?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined) => boolean" + ] + }, + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L51" + }, + "signature": [ + "(adapters: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", options?: ", + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorOptions", + "text": "InspectorOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ] + } + ], + "source": { + "path": "src/plugins/inspector/public/plugin.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L28" + }, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "id": "def-common.RequestAdapter", + "type": "Class", + "tags": [ + "extends" + ], + "label": "RequestAdapter", + "description": [ + "\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind." + ], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " extends ", + "EventEmitter" + ], + "children": [ + { + "id": "def-common.RequestAdapter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L24" + } + }, + { + "id": "def-common.RequestAdapter.start", + "type": "Function", + "label": "start", + "signature": [ + "(name: string, params?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestParams", + "text": "RequestParams" + }, + ") => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "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" + ], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "The name of this request as it should be shown in the UI." + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestParams", + "text": "RequestParams" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39" + } + }, + { + "id": "def-common.RequestAdapter.reset", + "type": "Function", + "label": "reset", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L52" + } + }, + { + "id": "def-common.RequestAdapter.resetRequest", + "type": "Function", + "label": "resetRequest", + "signature": [ + "(id: string) => void" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57" + } + }, + { + "id": "def-common.RequestAdapter.getRequests", + "type": "Function", + "label": "getRequests", + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Request", + "text": "Request" + }, + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L62" + } + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RequestResponder", + "type": "Class", + "tags": [], + "label": "RequestResponder", + "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}." + ], + "children": [ + { + "id": "def-common.RequestResponder.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Request", + "text": "Request" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + }, + { + "type": "Function", + "label": "onChange", + "isRequired": true, + "signature": [ + "() => void" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20" + } + }, + { + "id": "def-common.RequestResponder.json", + "type": "Function", + "label": "json", + "signature": [ + "(reqJson: object) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "text": "RequestResponder" + } + ], + "description": [], + "children": [ + { + "type": "Uncategorized", + "label": "reqJson", + "isRequired": true, + "signature": [ + "object" + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25" + } + }, + { + "id": "def-common.RequestResponder.stats", + "type": "Function", + "label": "stats", + "signature": [ + "(stats: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + }, + ") => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestResponder", + "text": "RequestResponder" + } + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "stats", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31" + } + }, + { + "id": "def-common.RequestResponder.finish", + "type": "Function", + "label": "finish", + "signature": [ + "(status: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatus", + "text": "RequestStatus" + }, + ", response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Enum", + "label": "status", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatus", + "text": "RequestStatus" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + }, + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53" + } + }, + { + "id": "def-common.RequestResponder.ok", + "type": "Function", + "label": "ok", + "signature": [ + "(response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60" + } + }, + { + "id": "def-common.RequestResponder.error", + "type": "Function", + "label": "error", + "signature": [ + "(response: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "response", + "isRequired": true, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Response", + "text": "Response" + } + ], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64" + } + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L16" + }, + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "id": "def-common.Adapters", + "type": "Interface", + "label": "Adapters", + "description": [ + "\nThe interface that the adapters used to open an inspector have to fullfill." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Adapters.requests", + "type": "Object", + "label": "requests", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15" + }, + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" + ] + }, + { + "id": "def-common.Adapters.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RequestStatistic", + "type": "Interface", + "label": "RequestStatistic", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RequestStatistic.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L49" + } + }, + { + "tags": [], + "id": "def-common.RequestStatistic.description", + "type": "string", + "label": "description", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L50" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RequestStatistic.value", + "type": "Any", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L51" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 48, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L48" + }, + "initialIsOpen": false + }, + { + "id": "def-common.RequestStatistics", + "type": "Interface", + "label": "RequestStatistics", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.RequestStatistics.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L45" + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L44" + }, + "initialIsOpen": false + } + ], + "enums": [ + { + "id": "def-common.RequestStatus", + "type": "Enum", + "label": "RequestStatus", + "tags": [], + "description": [ + "\nThe status a request can have." + ], + "source": { + "path": "src/plugins/inspector/common/adapters/request/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L12" + }, + "initialIsOpen": false + } + ], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx new file mode 100644 index 0000000000000..1fe62ba63e26e --- /dev/null +++ b/api_docs/inspector.mdx @@ -0,0 +1,44 @@ +--- +id: kibInspectorPluginApi +slug: /kibana-dev-docs/inspectorPluginApi +title: inspector +image: https://source.unsplash.com/400x175/?github +summary: API docs for the inspector plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- + +import inspectorObj from './inspector.json'; + +## Client + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Common + +### Classes + + +### Interfaces + + +### Enums + + diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json new file mode 100644 index 0000000000000..183ab1e9169e0 --- /dev/null +++ b/api_docs/kibana_legacy.json @@ -0,0 +1,1789 @@ +{ + "id": "kibanaLegacy", + "client": { + "classes": [ + { + "id": "def-public.KibanaLegacyPlugin", + "type": "Class", + "tags": [], + "label": "KibanaLegacyPlugin", + "description": [], + "children": [ + { + "id": "def-public.KibanaLegacyPlugin.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "initializerContext", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L15" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L15" + } + }, + { + "id": "def-public.KibanaLegacyPlugin.setup", + "type": "Function", + "label": "setup", + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<{}, { dashboardConfig: ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.DashboardConfig", + "text": "DashboardConfig" + }, + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "core", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<{}, { dashboardConfig: ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.DashboardConfig", + "text": "DashboardConfig" + }, + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L17" + } + }, + { + "id": "def-public.KibanaLegacyPlugin.start", + "type": "Function", + "label": "start", + "signature": [ + "({ application, http: { basePath }, uiSettings }: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => { dashboardConfig: ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.DashboardConfig", + "text": "DashboardConfig" + }, + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ application, http: { basePath }, uiSettings }", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L21" + } + } + ], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ToastNotifications", + "type": "Class", + "tags": [], + "label": "ToastNotifications", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ToastNotifications.list", + "type": "Array", + "label": "list", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L12" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]" + ] + }, + { + "id": "def-public.ToastNotifications.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "toasts", + "isRequired": true, + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastsApi", + "text": "ToastsApi" + }, + ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16" + } + }, + { + "id": "def-public.ToastNotifications.onChange", + "type": "Function", + "children": [ + { + "type": "Function", + "label": "callback", + "isRequired": true, + "signature": [ + "() => void" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26" + } + } + ], + "signature": [ + "(callback: () => void) => void" + ], + "description": [], + "label": "onChange", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.add", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30" + } + } + ], + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "label": "add", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.remove", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "toast", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31" + } + } + ], + "signature": [ + "(toast: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void" + ], + "description": [], + "label": "remove", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.addSuccess", + "type": "Function", + "children": [ + { + "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": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32" + } + } + ], + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "label": "addSuccess", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.addWarning", + "type": "Function", + "children": [ + { + "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": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33" + } + } + ], + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "label": "addWarning", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.addDanger", + "type": "Function", + "children": [ + { + "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": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34" + } + } + ], + "signature": [ + "(toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "label": "addDanger", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ToastNotifications.addError", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35" + } + } + ], + "signature": [ + "(error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + } + ], + "description": [], + "label": "addError", + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35" + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L11" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "tags": [], + "id": "def-public.initAngularBootstrap", + "type": "Function", + "label": "initAngularBootstrap", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular_bootstrap/index.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular_bootstrap/index.ts#L15" + }, + "signature": [ + "() => void" + ], + "initialIsOpen": false + }, + { + "id": "def-public.PaginateDirectiveProvider", + "type": "Function", + "label": "PaginateDirectiveProvider", + "signature": [ + "($parse: any, $compile: any) => any" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "$parse", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9" + } + }, + { + "type": "Any", + "label": "$compile", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PaginateControlsDirectiveProvider", + "type": "Function", + "label": "PaginateControlsDirectiveProvider", + "signature": [ + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 10, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L10" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PromiseServiceCreator", + "type": "Function", + "label": "PromiseServiceCreator", + "signature": [ + "($q: unknown, $timeout: unknown) => (fn: unknown) => unknown" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "$q", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9" + } + }, + { + "type": "Unknown", + "label": "$timeout", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.watchMultiDecorator", + "type": "Function", + "label": "watchMultiDecorator", + "signature": [ + "($provide: unknown) => void" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "$provide", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9" + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.createTopNavHelper", + "type": "Function", + "label": "createTopNavHelper", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L14" + }, + "signature": [ + "(options: unknown) => angular.Injectable>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.loadKbnTopNavDirectives", + "type": "Function", + "label": "loadKbnTopNavDirectives", + "signature": [ + "(navUi: unknown) => void" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "navUi", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17" + }, + "initialIsOpen": false + }, + { + "id": "def-public.subscribeWithScope", + "type": "Function", + "label": "subscribeWithScope", + "signature": [ + "($scope: angular.IScope, observable: ", + "Observable", + ", observer: ", + "NextObserver", + " | ", + "ErrorObserver", + " | ", + "CompletionObserver", + " | 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." + ], + "children": [ + { + "type": "Object", + "label": "$scope", + "isRequired": true, + "signature": [ + "angular.IScope" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L40" + } + }, + { + "type": "Object", + "label": "observable", + "isRequired": true, + "signature": [ + "Observable", + "" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L41" + } + }, + { + "type": "CompoundType", + "label": "observer", + "isRequired": false, + "signature": [ + "NextObserver", + " | ", + "ErrorObserver", + " | ", + "CompletionObserver", + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L42" + } + }, + { + "type": "Function", + "label": "fatalError", + "isRequired": false, + "signature": [ + "FatalErrorFn | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L43" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-public.configureAppAngularModule", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "angularModule", + "isRequired": true, + "signature": [ + "angular.IModule" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L63" + } + }, + { + "id": "def-public.configureAppAngularModule.newPlatform", + "type": "Object", + "label": "newPlatform", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.configureAppAngularModule.newPlatform.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L65" + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ] + }, + { + "tags": [], + "id": "def-public.configureAppAngularModule.newPlatform.env", + "type": "Object", + "label": "env", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L66" + }, + "signature": [ + "{ mode: Readonly<", + "EnvironmentMode", + ">; packageInfo: Readonly<", + "PackageInfo", + ">; }" + ] + } + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L64" + } + }, + { + "type": "boolean", + "label": "isLocalAngular", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L71" + } + }, + { + "type": "Function", + "label": "getHistory", + "isRequired": false, + "signature": [ + "(() => ", + "History", + ") | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L72" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L62" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.$setupXsrfRequestInterceptor", + "type": "Function", + "children": [ + { + "type": "string", + "label": "version", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136" + } + } + ], + "signature": [ + "(version: string) => ($httpProvider: angular.IHttpProvider) => void" + ], + "description": [], + "label": "$setupXsrfRequestInterceptor", + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 136, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.formatESMsg", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "err", + "isRequired": true, + "signature": [ + "string | Record" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.formatMsg", + "type": "Function", + "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" + ], + "children": [ + { + "type": "CompoundType", + "label": "err", + "isRequired": true, + "signature": [ + "string | Record" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21" + } + }, + { + "type": "string", + "label": "source", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- Prefix for message indicating source (optional)" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21" + }, + "initialIsOpen": false + }, + { + "id": "def-public.formatStack", + "type": "Function", + "label": "formatStack", + "signature": [ + "(err: Record) => any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "err", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.isAngularHttpError", + "type": "Function", + "label": "isAngularHttpError", + "signature": [ + "(error: any) => boolean" + ], + "description": [], + "children": [ + { + "type": "Any", + "label": "error", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.formatAngularHttpError", + "type": "Function", + "label": "formatAngularHttpError", + "signature": [ + "(error: ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + }, + ") => string" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "error", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.addFatalError", + "type": "Function", + "label": "addFatalError", + "signature": [ + "(fatalErrors: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + }, + ", error: string | Error | ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + }, + ", location: string | undefined) => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "fatalErrors", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L17" + } + }, + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "string | Error | ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L18" + } + }, + { + "type": "string", + "label": "location", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L19" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PrivateProvider", + "type": "Function", + "label": "PrivateProvider", + "signature": [ + "() => angular.IServiceProvider" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/private.d.ts#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.registerListenEventListener", + "type": "Function", + "label": "registerListenEventListener", + "signature": [ + "($rootScope: unknown) => void" + ], + "description": [], + "children": [ + { + "type": "Unknown", + "label": "$rootScope", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts", + "lineNumber": 9, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9" + }, + "initialIsOpen": false + }, + { + "id": "def-public.addSystemApiHeader", + "type": "Function", + "label": "addSystemApiHeader", + "signature": [ + "(originalHeaders: Record) => { \"kbn-system-request\": boolean; }" + ], + "description": [ + "\nAdds a custom header designating request as system API" + ], + "children": [ + { + "type": "Object", + "label": "originalHeaders", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [ + "Object representing set of headers" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L19" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-public.isSystemApiRequest", + "type": "Function", + "label": "isSystemApiRequest", + "signature": [ + "(request: angular.IRequestConfig) => boolean | undefined" + ], + "description": [ + "\nReturns true if request is a system API request; false otherwise\n" + ], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + "angular.IRequestConfig" + ], + "description": [ + "Object Request object created by $http service" + ], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L35" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L35" + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.RouteConfiguration", + "type": "Interface", + "label": "RouteConfiguration", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.RouteConfiguration.controller", + "type": "CompoundType", + "label": "controller", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L29" + }, + "signature": [ + "string | ((...args: any[]) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.redirectTo", + "type": "string", + "label": "redirectTo", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L30" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.resolveRedirectTo", + "type": "Function", + "label": "resolveRedirectTo", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L31" + }, + "signature": [ + "((...args: any[]) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.reloadOnSearch", + "type": "CompoundType", + "label": "reloadOnSearch", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L32" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.reloadOnUrl", + "type": "CompoundType", + "label": "reloadOnUrl", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L33" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.outerAngularWrapperRoute", + "type": "CompoundType", + "label": "outerAngularWrapperRoute", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L34" + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.resolve", + "type": "Uncategorized", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L35" + }, + "signature": [ + "object | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.template", + "type": "string", + "label": "template", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L36" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.k7Breadcrumbs", + "type": "Function", + "label": "k7Breadcrumbs", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L37" + }, + "signature": [ + "((...args: any[]) => ", + "EuiBreadcrumb", + "[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.RouteConfiguration.requireUICapability", + "type": "string", + "label": "requireUICapability", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L38" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L28" + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.KibanaLegacySetup", + "type": "Type", + "label": "KibanaLegacySetup", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L45" + }, + "signature": [ + "{}" + ], + "initialIsOpen": false + }, + { + "id": "def-public.KibanaLegacyStart", + "type": "Type", + "label": "KibanaLegacyStart", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L46" + }, + "signature": [ + "{ dashboardConfig: ", + "DashboardConfig", + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.createTopNavDirective", + "type": "CompoundType", + "label": "createTopNavDirective", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L11" + }, + "signature": [ + "angular.Injectable>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AngularHttpError", + "type": "Type", + "label": "AngularHttpError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L12" + }, + "signature": [ + "IHttpResponse<{ message: string; }>" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.KbnAccessibleClickProvider", + "type": "CompoundType", + "label": "KbnAccessibleClickProvider", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts#L11" + }, + "signature": [ + "angular.Injectable>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.IPrivate", + "type": "Type", + "label": "IPrivate", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", + "lineNumber": 11, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/private.d.ts#L11" + }, + "signature": [ + "(provider: (...injectable: any[]) => T) => T" + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kibana_legacy.mdx b/api_docs/kibana_legacy.mdx new file mode 100644 index 0000000000000..208cb8013d063 --- /dev/null +++ b/api_docs/kibana_legacy.mdx @@ -0,0 +1,27 @@ +--- +id: kibKibanaLegacyPluginApi +slug: /kibana-dev-docs/kibanaLegacyPluginApi +title: kibanaLegacy +image: https://source.unsplash.com/400x175/?github +summary: API docs for the kibanaLegacy plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaLegacy'] +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 kibanaLegacyObj from './kibana_legacy.json'; + +## Client + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json new file mode 100644 index 0000000000000..591d0aef52a73 --- /dev/null +++ b/api_docs/kibana_react.json @@ -0,0 +1,4124 @@ +{ + "id": "kibanaReact", + "client": { + "classes": [ + { + "id": "def-public.ValidatedDualRange", + "type": "Class", + "tags": [], + "label": "ValidatedDualRange", + "description": [], + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.ValidatedDualRange", + "text": "ValidatedDualRange" + }, + " extends React.Component" + ], + "children": [ + { + "id": "def-public.ValidatedDualRange.defaultProps", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ValidatedDualRange.defaultProps.allowEmptyRange", + "type": "boolean", + "label": "allowEmptyRange", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L41" + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "id": "def-public.ValidatedDualRange.defaultProps.fullWidth", + "type": "boolean", + "label": "fullWidth", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L42" + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "id": "def-public.ValidatedDualRange.defaultProps.compressed", + "type": "boolean", + "label": "compressed", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L43" + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "defaultProps", + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L40" + } + }, + { + "id": "def-public.ValidatedDualRange.getDerivedStateFromProps", + "type": "Function", + "label": "getDerivedStateFromProps", + "signature": [ + "typeof ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.ValidatedDualRange", + "text": "ValidatedDualRange" + }, + ".getDerivedStateFromProps" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "nextProps", + "isRequired": true, + "signature": [ + "Props" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46" + } + }, + { + "type": "Object", + "label": "prevState", + "isRequired": true, + "signature": [ + "State" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46" + } + }, + { + "id": "def-public.ValidatedDualRange.state", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "state", + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L66" + } + }, + { + "id": "def-public.ValidatedDualRange._onChange", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "value", + "isRequired": true, + "signature": [ + "[React.ReactText, React.ReactText]" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L68" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L68" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ValidatedDualRange.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 87, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L87" + } + } + ], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 39, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L39" + }, + "initialIsOpen": false + }, + { + "id": "def-public.TableListView", + "type": "Class", + "tags": [], + "label": "TableListView", + "description": [], + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListView", + "text": "TableListView" + }, + " extends React.Component<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewProps", + "text": "TableListViewProps" + }, + ", ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewState", + "text": "TableListViewState" + }, + ", any>" + ], + "children": [ + { + "id": "def-public.TableListView.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewProps", + "text": "TableListViewProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L90" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 90, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L90" + } + }, + { + "id": "def-public.TableListView.UNSAFE_componentWillMount", + "type": "Function", + "label": "UNSAFE_componentWillMount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L111" + } + }, + { + "id": "def-public.TableListView.componentWillUnmount", + "type": "Function", + "label": "componentWillUnmount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L115" + } + }, + { + "id": "def-public.TableListView.componentDidMount", + "type": "Function", + "label": "componentDidMount", + "signature": [ + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L120" + } + }, + { + "tags": [], + "id": "def-public.TableListView.debouncedFetch", + "type": "Function", + "label": "debouncedFetch", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L124" + }, + "signature": [ + "((filter: string) => Promise) & _.Cancelable" + ] + }, + { + "id": "def-public.TableListView.fetchItems", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "fetchItems", + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L156" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.TableListView.deleteSelectedItems", + "type": "Function", + "children": [], + "signature": [ + "() => Promise" + ], + "description": [], + "label": "deleteSelectedItems", + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 166, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L166" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.TableListView.closeDeleteModal", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "closeDeleteModal", + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 196, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L196" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.TableListView.openDeleteModal", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], + "description": [], + "label": "openDeleteModal", + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 200, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L200" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.TableListView.setFilter", + "type": "Function", + "label": "setFilter", + "signature": [ + "({ queryText }: { queryText: string; }) => void" + ], + "description": [], + "children": [ + { + "id": "def-public.TableListView.setFilter.{-queryText }", + "type": "Object", + "label": "{ queryText }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.TableListView.setFilter.{-queryText }.queryText", + "type": "string", + "label": "queryText", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204" + } + } + ], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 204, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204" + } + }, + { + "id": "def-public.TableListView.hasNoItems", + "type": "Function", + "label": "hasNoItems", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L215" + } + }, + { + "id": "def-public.TableListView.renderConfirmDeleteModal", + "type": "Function", + "label": "renderConfirmDeleteModal", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L223" + } + }, + { + "id": "def-public.TableListView.renderListingLimitWarning", + "type": "Function", + "label": "renderListingLimitWarning", + "signature": [ + "() => JSX.Element | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L277" + } + }, + { + "id": "def-public.TableListView.renderFetchError", + "type": "Function", + "label": "renderFetchError", + "signature": [ + "() => JSX.Element | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L319" + } + }, + { + "id": "def-public.TableListView.renderNoItemsMessage", + "type": "Function", + "label": "renderNoItemsMessage", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 350, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L350" + } + }, + { + "id": "def-public.TableListView.renderToolsLeft", + "type": "Function", + "label": "renderToolsLeft", + "signature": [ + "() => JSX.Element | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 364, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L364" + } + }, + { + "id": "def-public.TableListView.renderTable", + "type": "Function", + "label": "renderTable", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L395" + } + }, + { + "id": "def-public.TableListView.renderListingOrEmptyState", + "type": "Function", + "label": "renderListingOrEmptyState", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 475, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L475" + } + }, + { + "id": "def-public.TableListView.renderListing", + "type": "Function", + "label": "renderListing", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 483, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L483" + } + }, + { + "id": "def-public.TableListView.renderPageContent", + "type": "Function", + "label": "renderPageContent", + "signature": [ + "() => JSX.Element | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 528, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L528" + } + }, + { + "id": "def-public.TableListView.render", + "type": "Function", + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 540, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L540" + } + } + ], + "source": { + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L86" + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-public.Markdown", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.MarkdownProps", + "text": "MarkdownProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L28" + } + } + ], + "signature": [ + "(props: ", + "MarkdownProps", + ") => JSX.Element" + ], + "description": [], + "label": "Markdown", + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.MarkdownSimple", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "props", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.MarkdownSimpleProps", + "text": "MarkdownSimpleProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L21" + } + } + ], + "signature": [ + "(props: ", + "MarkdownSimpleProps", + ") => JSX.Element" + ], + "description": [], + "label": "MarkdownSimple", + "source": { + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 21, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L21" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.reactToUiComponent", + "type": "Function", + "children": [ + { + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/react_to_ui_component.ts#L19" + } + } + ], + "signature": [ + "(ReactComp: React.ComponentType) => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + "" + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/react_to_ui_component.ts#L18" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.uiToReactComponent", + "type": "Function", + "children": [ + { + "type": "Function", + "label": "Comp", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L16" + } + }, + { + "type": "string", + "label": "as", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L17" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L15" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.toMountPoint", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "node", + "isRequired": false, + "signature": [ + "React.ReactNode" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/to_mount_point.tsx#L19" + } + } + ], + "signature": [ + "(node: React.ReactNode) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "description": [ + "\nMountPoint converter for react nodes.\n" + ], + "label": "toMountPoint", + "source": { + "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/to_mount_point.tsx#L19" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.MountPointPortal", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{ children, setMountPoint }", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/mount_point_portal.tsx#L22" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/mount_point_portal.tsx#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.RedirectAppLinks", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n application,\n children,\n className,\n ...otherProps\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/app_links/redirect_app_link.tsx#L38" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/app_links/redirect_app_link.tsx#L38" + }, + "tags": [ + "example", + "remarks" + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.CodeEditor", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "props", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.Props", + "text": "Props" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/code_editor/index.tsx#L22" + } + } + ], + "signature": [ + "(props: React.PropsWithChildren<", + "Props", + ">) => JSX.Element" + ], + "description": [], + "label": "CodeEditor", + "source": { + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/code_editor/index.tsx#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.UrlTemplateEditor", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.UrlTemplateEditorProps", + "text": "UrlTemplateEditorProps" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L40" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L40" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.createKibanaReactContext", + "type": "Function", + "children": [ + { + "type": "Uncategorized", + "label": "services", + "isRequired": true, + "signature": [ + "Services" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L46" + } + } + ], + "signature": [ + ">(services: Services) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContext", + "text": "KibanaReactContext" + }, + "" + ], + "description": [], + "label": "createKibanaReactContext", + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L45" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.KibanaContextProvider", + "type": "Function", + "label": "KibanaContextProvider", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 76, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L76" + }, + "signature": [ + "React.FC<{ services?: {} | undefined; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.useKibana", + "type": "Function", + "children": [], + "signature": [ + "() => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + " & Extra>" + ], + "description": [], + "label": "useKibana", + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L24" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.withKibana", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "type", + "isRequired": true, + "signature": [ + "React.ComponentType" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L32" + } + } + ], + "signature": [ + "; }>(type: React.ComponentType) => React.FC>>" + ], + "description": [], + "label": "withKibana", + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L31" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.UseKibana", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{ children }", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<{ children: (kibana: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + ") => React.ReactNode; }>" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L43" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L41" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.OverviewPageFooter", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx#L28" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx#L28" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.OverviewPageHeader", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx#L35" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx#L35" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.createReactOverlays", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "services", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/create_react_overlays.tsx#L14" + } + } + ], + "signature": [ + "(services: Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactOverlays", + "text": "KibanaReactOverlays" + } + ], + "description": [], + "label": "createReactOverlays", + "source": { + "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/create_react_overlays.tsx#L14" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.useUiSetting", + "type": "Function", + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22" + } + }, + { + "type": "Uncategorized", + "label": "defaultValue", + "isRequired": false, + "signature": [ + "T | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.useUiSetting$", + "type": "Function", + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47" + } + }, + { + "type": "Uncategorized", + "label": "defaultValue", + "isRequired": false, + "signature": [ + "T | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.FieldIcon", + "type": "Function", + "label": "FieldIcon", + "signature": [ + "({\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldIconProps", + "text": "FieldIconProps" + }, + ") => JSX.Element" + ], + "description": [ + "\nField token icon used across the app" + ], + "children": [ + { + "type": "Object", + "label": "{\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldIconProps", + "text": "FieldIconProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L53" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L53" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldButton", + "type": "Function", + "label": "FieldButton", + "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}: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldButtonProps", + "text": "FieldButtonProps" + }, + ") => JSX.Element" + ], + "description": [], + "children": [ + { + "type": "Object", + "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, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldButtonProps", + "text": "FieldButtonProps" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L68" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 68, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L68" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ToolbarButton", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "{\n children,\n className,\n fontWeight = 'normal',\n size = 'm',\n hasArrow = true,\n groupPosition = 'none',\n dataTestSubj = '',\n ...rest\n}", + "isRequired": true, + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.ToolbarButtonProps", + "text": "ToolbarButtonProps" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", + "lineNumber": 49, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx#L49" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx#L49" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.Panel", + "type": "Function", + "label": "Panel", + "signature": [ + "({ children, className, initialWidth = 100, style = {} }: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{ children, className, initialWidth = 100, style = {} }", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.Props", + "text": "Props" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel.tsx#L23" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel.tsx#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.PanelsContainer", + "type": "Function", + "label": "PanelsContainer", + "signature": [ + "({\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}: ", + "Props", + ") => JSX.Element" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}", + "isRequired": true, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.Props", + "text": "Props" + } + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel_container.tsx#L32" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel_container.tsx#L32" + }, + "initialIsOpen": false + }, + { + "id": "def-public.reactRouterNavigate", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "history", + "isRequired": true, + "signature": [ + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L27" + } + }, + { + "type": "CompoundType", + "label": "to", + "isRequired": true, + "signature": [ + "string | LocationObject" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L28" + } + }, + { + "type": "Object", + "label": "onClickCallback", + "isRequired": false, + "signature": [ + "Function | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L29" + } + } + ], + "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; }" + ], + "description": [], + "label": "reactRouterNavigate", + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L26" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.reactRouterOnClickHandler", + "type": "Function", + "children": [ + { + "type": "CompoundType", + "label": "history", + "isRequired": true, + "signature": [ + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L36" + } + }, + { + "type": "CompoundType", + "label": "to", + "isRequired": true, + "signature": [ + "string | LocationObject" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L37" + } + }, + { + "type": "Object", + "label": "onClickCallback", + "isRequired": false, + "signature": [ + "Function | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L38" + } + } + ], + "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, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L35" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.createNotifications", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "services", + "isRequired": true, + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/notifications/create_notifications.tsx#L14" + } + } + ], + "signature": [ + "(services: Partial<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ">) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactNotifications", + "text": "KibanaReactNotifications" + } + ], + "description": [], + "label": "createNotifications", + "source": { + "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/notifications/create_notifications.tsx#L14" + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.UrlTemplateEditorVariable", + "type": "Interface", + "label": "UrlTemplateEditorVariable", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.UrlTemplateEditorVariable.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L25" + } + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorVariable.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorVariable.documentation", + "type": "string", + "label": "documentation", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorVariable.kind", + "type": "CompoundType", + "label": "kind", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L28" + }, + "signature": [ + "languages", + ".CompletionItemKind | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorVariable.sortText", + "type": "string", + "label": "sortText", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L29" + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-public.UrlTemplateEditorProps", + "type": "Interface", + "label": "UrlTemplateEditorProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L32" + } + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.height", + "type": "CompoundType", + "label": "height", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L33" + }, + "signature": [ + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.variables", + "type": "Array", + "label": "variables", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L34" + }, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.UrlTemplateEditorVariable", + "text": "UrlTemplateEditorVariable" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.onChange", + "type": "Function", + "label": "onChange", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L35" + }, + "signature": [ + "(value: string) => void" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.onEditor", + "type": "Function", + "label": "onEditor", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L36" + }, + "signature": [ + "((editor: ", + "editor", + ".IStandaloneCodeEditor) => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UrlTemplateEditorProps.Editor", + "type": "CompoundType", + "label": "Editor", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L37" + }, + "signature": [ + "React.FunctionComponent<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.Props", + "text": "Props" + }, + "> | React.ComponentClass<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.Props", + "text": "Props" + }, + ", any> | undefined" + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L31" + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExitFullScreenButtonProps", + "type": "Interface", + "label": "ExitFullScreenButtonProps", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ExitFullScreenButtonProps.onExitFullScreenMode", + "type": "Function", + "label": "onExitFullScreenMode", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx#L15" + }, + "signature": [ + "() => void" + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx#L14" + }, + "initialIsOpen": false + }, + { + "id": "def-public.KibanaReactContext", + "type": "Interface", + "label": "KibanaReactContext", + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContext", + "text": "KibanaReactContext" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.KibanaReactContext.value", + "type": "Object", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L23" + }, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + "" + ] + }, + { + "tags": [], + "id": "def-public.KibanaReactContext.Provider", + "type": "Function", + "label": "Provider", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L24" + }, + "signature": [ + "React.FC<{ services?: T | undefined; }>" + ] + }, + { + "tags": [], + "id": "def-public.KibanaReactContext.Consumer", + "type": "Function", + "label": "Consumer", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L25" + }, + "signature": [ + "React.Consumer<", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + ">" + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-public.KibanaReactContextValue", + "type": "Interface", + "label": "KibanaReactContextValue", + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.KibanaReactContextValue.services", + "type": "Uncategorized", + "label": "services", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L17" + }, + "signature": [ + "Services" + ] + }, + { + "tags": [], + "id": "def-public.KibanaReactContextValue.overlays", + "type": "Object", + "label": "overlays", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L18" + }, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactOverlays", + "text": "KibanaReactOverlays" + } + ] + }, + { + "tags": [], + "id": "def-public.KibanaReactContextValue.notifications", + "type": "Object", + "label": "notifications", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L19" + }, + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactNotifications", + "text": "KibanaReactNotifications" + } + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/context/types.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L16" + }, + "initialIsOpen": false + }, + { + "id": "def-public.KibanaReactOverlays", + "type": "Interface", + "label": "KibanaReactOverlays", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.KibanaReactOverlays.openFlyout", + "type": "Function", + "label": "openFlyout", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/overlays/types.ts", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L13" + }, + "signature": [ + "(node: React.ReactNode, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ] + }, + { + "tags": [], + "id": "def-public.KibanaReactOverlays.openModal", + "type": "Function", + "label": "openModal", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/overlays/types.ts", + "lineNumber": 17, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L17" + }, + "signature": [ + "(node: React.ReactNode, options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/overlays/types.ts", + "lineNumber": 12, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L12" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldIconProps", + "type": "Interface", + "label": "FieldIconProps", + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldIconProps", + "text": "FieldIconProps" + }, + " extends Pick<", + "EuiTokenProps", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"id\" | \"title\" | \"size\" | \"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\" | \"onKeyDown\" | \"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\" | \"fill\" | \"shape\">" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FieldIconProps.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 14, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L14" + } + }, + { + "tags": [], + "id": "def-public.FieldIconProps.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L27" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.FieldIconProps.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L28" + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 13, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L13" + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldButtonProps", + "type": "Interface", + "label": "FieldButtonProps", + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldButtonProps", + "text": "FieldButtonProps" + }, + " extends React.HTMLAttributes" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.FieldButtonProps.fieldName", + "type": "CompoundType", + "label": "fieldName", + "description": [ + "\nLabel for the button" + ], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 18, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L18" + }, + "signature": [ + "React.ReactNode" + ] + }, + { + "tags": [], + "id": "def-public.FieldButtonProps.fieldIcon", + "type": "CompoundType", + "label": "fieldIcon", + "description": [ + "\nIcon representing the field type.\nRecommend using FieldIcon" + ], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L23" + }, + "signature": [ + "React.ReactNode" + ] + }, + { + "tags": [], + "id": "def-public.FieldButtonProps.fieldInfoIcon", + "type": "CompoundType", + "label": "fieldInfoIcon", + "description": [ + "\nAn optional node to place inside and at the end of the

W*_pdOd{W+4P?o&VT6AM%^E=?N1wX zap5`2J#sr=g4!C_Y~Wdb%j}qQ(yozvR$!ilUn5*rZ@O-iT`e{5=F-H22!XU5={c1J z)17Z4)%hJp^+>)!7H~Qw?MLu{N z9=ac--$-(YRqE1ja^KI;U^A2aTdby6zYNem$ z9dVpr{3x$5AE8S;o4tE^QDt_fPnkU1K(>0>jLXe8+G^_NIlaG5#XeT3j*m*#t5xWW zIUoO2f7J7=ZN}}EAM@GdNNYSt@4O9ax(F%bzFiN1o;glDi;V3=iq4wz!ItDytE3KW z9JXlio3X70VkZ_Am_|~*Rek*G$guuPPb)SizuD91Shx)@4EM0q>k=d&0eCzkX-Y# zxYV_HphnlJjg%ISJ7!wX^!`*JCyMDxx2sGpe^$=$T-fcJB_|Cv^z);{>%C71*b%o! zu2;&SN*fp|ZmgCiQ`yq2f%)hz&nex8aZ-3IQ8L?jYmOt=J^36ex9NCnw;f%VJHz(j zJR>t|*#`!bmBbj>Z_pJ+zdP-I+39#l;bZ>g zx*e$#pRxsPXUA@0y8Dmf4p;YhM~H1T%lcTvE?eSzW-r}U)gfBZF=4BAtLF3{uD4}> z;_IC#GsqGYcvt0dwCxgUsm{rB1WU4Hny~Y(i65YdxFx*JS97psnfNAWWj|yf(x-NA zyDxZ?Q!rIfClBfdWGbzRr?>#>zltHLUKS;_m&dY`w!T#Iqmkzg%X^s8P%ie=N+w&X6=B1on#G@HCzX zw<&efynSKU!U6U$d7AotI=X}DPpd&2NdCN(^<(7z`M&$q^h0Zc*Xa?b>(XT8++r;U zo)txbo|aiX$BA7 z%;B@|Ts$*L_pdb+%oEB~7tDNIaMIAsdX|hd2^FBFIDp@Tu zspY@5a4U`nN=w`-50l10+DYFrC^lAsP$n2pD9`({S>~9d^}8i55g=|RoZ)3uUw3lj zI^L+@ytZ_)un*^ZJUE`u15v}n|ul}=pqqpJw7NR{gkRN zQW^BQ>;U33_%2s+_IpQ2b4k?<(1{n>LO=Td*n9JEsM|Jf{1(wBl}ZsRMP)17WY=AY zj5TEJm1T^f?CT(vHsls!Y=yCo5n~(1M2pba2E&XQ$`*r>!DJcpes$l^``p{_`2GJL z&wq0qGxJ@p>%7k8bAHbA91wrgLDT8K>ZiUP`};Y7h)whqIxQp=Tf~O>Z4MRQFL@R+ zZM`~PrP$~ubId>A)=D+t!&{TuV=IkCG>OTzzKmBZYkkBFRp>bP{Oe1B;2IkY`{PEk z&)@pH1H{IE{js;9|@@jDt21R53iP}RxQN|f#=!5 z@$x)!g3mHG!xGj+_dpC+80iYAf{E`>PHI|3*{lQpmlL^dPZ6%*LR^_FZtjYf+*2wY3v;$te8yy0O$vCl`Gr zpTm&vo!*VnwqW0T_dpjR`jOq;;hfRLf$JJe&j%2~MFmmv$zKw+#`<--BQ%3NWefwg zhesYDYdibIj-lHMtOr!5{qT1F$@ZluF?q*uJUVFo0)jgwAN-B~CB?-@W2HzcKNi~J znw-j5gz<+>>>e2PlWYv&NXM@%XN(RaDO;nsx!P;bHrA+;PCE)@t*8Gqlshn<`p7QluXL-#E< z0c|dQoiwp9`PLxj?1adaBz$EBC{JB0^)d%X%~h*Dz^;CP2Wx*5ILyCHX!k97E#?-! zs`A6HL!7(a9T%i=osuE_a3JIr)F7D6NnC3!Y(2Oq7UDJwg?;u0E=Tmyl|O z+3(nzE#hd1M70_<`(b_h9Za>FkinhH{<&bXOon@<+BEw$0z;906qP<10?F$eF!t$> z;NEws@JTDT#*qtBPjrre(BDhRsnUYSp>sqaoDOF$OS1h3>Re;PewJ7{T%Le7H>{DV&c-AL#=d_z`ZI^C-z>k=L=&N(v6Lutu};Ptw6Px4kJ@m z^0jy;(vMpj0z)0=Z{#iSU^xe*ne4Dob^J9(8PfgeU9ho((VM z*5+C|L-QEosy&7u55L*iD@V?_wX%u2M5Fk9sV`hj$SABH;56`{O(HzJHc$Nytkl@X z{3_P%=W9+8@3S<$SdNTJpuO#UfD*;82p%+<2b-VIEvP;x9ih}lJ$0n4a@Es$2ggTr zhTPPPgoLxkCeaM%urGE=ocDtpU+KA&<##{}P`+lrs2@Fri;IKYd-@QV3DU$VsAmXa z<0ITTfHFHQcz9@BCj=UwC{~VF`QmO$CS`b#g^o?a5A1n_c5E3gkHv(f>Ul10)8wGXh= z(A!g&C!$lq$pa)rWOjtl3($yQ#J6YOiaG1`-4qFmobt=1kNA;P#J2#u^P@?R0mln( zGPfJPYfSCL8@KlNs$&Djd(?Jf*L!kP)pDxZv@xP(KY}QGRs$B(P`c?8uVcQtSXt5L z*LdDF>Uo_Hxy5=W+%0-rqR3mYkUo{IAUM-sgIvc@_>5yMGq9<4gi^)DG^mw4)zipcIAw@CohCTek9&= z{zhIKe&^E}vv&N>T{`y%<6Q6;cEWHTil;z7zN&Tkv-awI9)ibW?)sX?QtO$ZmwO*q z2W3dZYl<$(Am<}TFQl_biuCx}AeA!W=F&rs4@sqm|ErTI3-ydUuI!sUO3YXvEr^63 z3(!+W2DUKJsP-mwHimGI>U=|2nTLmp(O@c^=GqqZ{q+6$pK6-QgzCSOd zdHFS+8t3MSNStOGA=~QC7DlHI0KS7uMvE5+7dph$VK*Cf#l!u|rr0Yd$Z`C1l^hSJ zBl5|G5p!Jx4NfZfE7Gu_F&odb8RYrGV^DNtp_wi*hUGodrxoeK%yBEQTe^lqOP0 z7e0RP)AD|^B&d$NcD;Lw>I47ui(h(ll@aTBuCVe zk~1vfzVF$^HhBU++?O!1)=hLzmyV}6=SibuCiY%;WuwU-iJ;~9W7j`&oM1y`kBdX2 zG6{;XIfNpk1<-?Qny%Y^g2*v*=DFtl*kK62>!sb1b^gfc;m{62Bcb4V@N=N! z3IF9V)3T@O05;U(`da5RhaZ!gNSJWFP_qxcIoIU66CibYHMOj2!anM-$KWU<|90B} z`VKR-t9?yGp4U9`XdO%&{%Ebxa+p=2(8QWo^7`l@?@mv057{s~q?y@mD_H_he(xe5 zXYAhhswjZFAcGg9j>g^@RvJw3j|HV#tY1@&N`WG9-75XPz=SrClnnR+c+flQSh3fe z0ws#*1WEc(5MTG`lNeKA(({5&FH zZNm0r8!#Pth8U#V(Y(BbM>L5jKu%Jg1;3e|@=Vz2hs(MVr>fp@Hg`fTxSwInO*E#M zrNVEj1(@q%j9v{$bc^O?EQMc#DH@!f%N#^((pX~EO`0PES4g2g=XxN>QB9gS5=Zn2&;z&pm1%9xJfG6UA)J+m`!O>|8oyn@+NLJ|gMs_~Zfd#0$HXa|GX91$-E-c? zYz5W zDu_Nq6x!T(0c5$q?S8b4^kTQxSavJmQ?kRq%8?o^ zk!SS_cDj$ZTG$(~_w4o@nk*7MWxq&vwipUw(W2uVF91r48kI?t?kq*0E_l~B5;nz4 zmu}ABZH~aQ#!kGOXS+|S&ibSV6~1iE8%UA)4KX!;YZEbXdO|HX<=o)f z&^X2(?#peGa^(K4vjJcg@^y z#J?y)9Lf9RW6R%SHORi7{uXw_8?rP7X9y5^uDp$;$AqJ5Mi* zyG7lti8&wad{+VpH;SSM#MwIIiA$4{NYavHE&Ut2N4R!RsNj+5=xvlC0-AF`4oQET zDr;*nnQn1bwOT#*!P4yA7X*k}S{Gc+E%qg%nOAuJmu)_8rG!Jjm4DR$&VJ+ad`Kt< z&Bo_3;A_3GeZ6Vf+5zIPObts&2lseRn=cBzOaPo`ag(+5k{eBp(`Fuz2@V29XM7Ac z{H;uR&_x2Fpu~!4R+ompXu6KuaMKv}uzTVy+(Yy{@u>zON$le8*}Hr&nTw@Al2@7) zNx<%4cFVgA!@4D&t)HJ&a}I>%^J`|*P*Gv=RtW(>!u99LzSTt>sfCVo9mL;Vjig63 zgtnAAjkHSAPFL1gw6u33@9pq(YwtK4^zF7oSJCln=Scy)kZC868ZC+lc@RWTYIBYd zU%T}iznY?I?8!mX>A;3Mw*9=v;LnW{s8u&l&_z9!H~j|VUaAex`$YhDQ{T?xtEMvc z_~+jfvo4zZ&jj$u*E(koXTEdc?zaG4ntzu)Fbo8Prf-6(o=!L9zfd+tiU+o$IVtDz z>Oe)sixnN-$!g*p3*_6uUvjC6k2M$jyJN`hB$RX3w6aII-TnUak6EJyVuss+A>9O7 z1&!7{G1;u=jEtNFX%Edkz&UK>#~L6_S-R)5rl@_`yHZ2sXOC)am%S|M&w>g-6&fXj zf|u12-&=PB%h*1Zs#(ULt?eEe2wSQLocM8|d6RbHw3D(AK|%X-k=+~>+e?d+t~EOb z#Bg~lj)AmE#B{)Abb8;%J-=FX1YC6-dRA!-Cd@bM&*H zTSpkNn8rjGna0o60BMHOVb0q;x;=Y?GEwXVC!G=;*I&MzPlZ)6ua!6TbezNR$cqJ# zO|Yl}#HPxYVwV6;sUulhY+nz1Ez9onv)e_NG&%M+qmEQCK1Tj&vmtSf8<8YQ5A3^0 zj?UU7mC4ymQ85D@cV#D$O0}bk%N=VUJC=wVS*T*S+=4gnm!Ivb8JcxX)_U`GsAXW5IbYWPi=CiMX^X1~3{0&@l&l@P?Jtddxf`B ze+irt=Quf8kf*hGq*wB{y$@(U9hW&R`cK`SAAM{>IxBMwzQ!BcAAX)x!T~1Kbh}Rw zK87yzrqBe!YujE?4U^Qu%dEmBb(wX-cRQYwqf=?79eH{2(?z$M$2T+Ve{OAI)*P&G zAw#7*lsbwq5>E@?P1NT7o=z${qTf~29ck;35*eHzO-v%U7Np;lm* z?;U&vdtUY8IKMK^eyG>Av~5FIq@7sn>oagevB5HYGRP03d1vdCiDWnf!8f_O zP4Kx_MP9(P?#4y3A`I5t|MzPbfZ%KlR z7t8`+C|kmX9c=aiLL0ihLn1N^=ZJ-AW4I zNf~6)HUpMyuTUSax+ss=Q0vR_kNX8i`(XnitA_Dlf`9YlG6f4b4%<-j+|cpRI)oC-M;#U+Z-EMC&IG33}o=biPpdaJYv3a8q*QQTxriypbBR zWe@Y}q?W`})a3--oNAr3syO*l(Se zs(~Q2crReU`v52^H?}Vs+2F@a;yk+qXbcH(m_ExSeUE7J#ov2h4oO@cs~5 zAPM~{<*Z_@i7V-@R$#-HVmAv{d`^a=Sp!V){ z@5%3J^6NaRjSu`v_toEyRY|5YS9J+p*0p9>mlN3`?)ed`L>1ql^N+;cvK})(yQqgG z{&D(GnHOz?_y{yY!VO?O<1f7LTqgS)W?u^wR%z>-30wI<6mPOo0TY1%2NAxfE(AMM z-Ym)oYmMsu045=98>(8Hr=Kfc3}W3Wl!?$XGQclB1YJWO3)~{?UL=!hG8$;-f0!4u zXi1M}!z_e$0%lw#5s+n_tIokBc%|R6m#-~EcJ{3ean^@JmdO!6ZPk=LgBMcEdScHX z-svyaU0EG~HEM^uFV(qBRq1lHZ09eiB9=D1&V2)p%7i~M1G=hOR3Ma4V^lamY4H6a z?8H5ebFlgeVtmbRHE~e((KE)x?e5ZcoVnP1lVckC%d^Q_ny9~ z3jT&tftvXPx5NjzCHM6je3sVg*b`{>$8ah`7XUOAAHBSzX+B`Rl_dgsl{DbQ4tB3L zGbOY!HR`VwgjR+M*SjYlQodJ$ee`67w-CMV`H?0ZxOBF0l>H)0a_V5${dieMp04QCNqUv+%kOz-!7 zL$}x^LFC5YiB#rA+jm*(F}Mdk3i~Kcp($`y&jZJj5Pa;d?7Md#2_K% zadKe@by~1<|0MsfarfzUck|e?l`F5_1aUNcL#>s+jx4*6>mvQyspV5mxazh5geIvi z!h)nS8+{mj((qtFt&pietaZl7PJ0b>EyI-K^N@YscSJx^Yc3)(9&k1ozt~!h8H!`}RuY^C1E|q=e#1)Rs=!df+0q9CdOfHl$Ss$Z%pA9t z_eMKo67TKxEU?!J%v$Wf9=cd>kvdq)W836lXIJZkm-G&R&DQ4}ZLq+FzSmB~5diO> zI5xEZ*6m&qBvOJA4llos3V^brD_Vpy>b7L=UNr`y0{7N%#lXBCzF>JB{1!VntUC#< zLG0S?Ss$~H)8t7H(8Y{}h^Nw}(X_i%$9MSs8iCn54ia~NoUp7mKHY^cQx9qo`@(aP-2?U&2AvUb*H-onE-8$LeY&kjdD(n*WELizi{^UH!fQzi*@(1 z0kc{TwV=>c~8w>M+Sw|tY>8*^+) z^aozEvn6+W4*X)6aiDyOER1fck6cM4mk(p zt>l4^V$`auhEYQ56XGdpRG~yinKGM4j;S;K_zUD^1$FKo%;Vo0;^|i?h~NOk0?&{m zs53ULoT*cUi}W07L~JgDFe?utC6`5KStjJCKfT{25p#GLFp|U7jnqT)PENZwe_58c zI5c(_wm2BNVjX)1Xbbx~D&aMd{oAsa6r}=xqNl`~9pc-YsSTGpBDu*+W_4Y)OtC95 z>;rOw9~)oR8={7mq78e8{V)Mu`;_ZyHI?{$snxB=-MyFJl2 z>WzIw{R$S-# z`D(9$1v)MY1n95cXG&it4xRa+s~$RoD!wP@GmyUHcY$$6XoIsug7WRlx~C-!gAcLe zqPO&#m*;dsW4I3b!xUd<%dVdY!*UEU`EWsH!g^LQTY?3i<5nh|Mp1!<3e@X?ziYwGqVonFh3-lddB$CtC;2PaQJ-#Kdr`S+zFo>LB@|kQ2_w zlt&)O+o0nSfte#74?3%iV3==;d7>^mP<3vfV8A&m1Z6{zAJJ#sJ6`eVa;&)qtmEay zxx5fuS3r9qm6}gjh}xJIQSznd&;y-1`+9rb8|5=pQ>z&RZCh->Qq-=Han;1Ssh(78 zXI2=IkM;7l*L5g(8ycUlde4hIOl81~b^W^<7b%|g&4f50ebdlY(COX$S~03xYQlCT#O!0#VmjB+jZDsX zDkDJ#mrI_P0{|k1SM&JqLd)Y!4;#` zhr+2PcEaj&<72b09S9%K#!;^;9QmbM6Du`@DydJhm2CiEjgE^^BPvA&oXe3*)8qLJ zV+_X~EEY;O7<{{@CbQT{_4(Q(=*_Yi5#(^wb0xr=ZX_*NPCN~ZA4@;?>FXr2I68F_ zpbVi@wOSijYDVIU?F|HPXH!^5Fuvem1mLP?Zi8eLA~5lh99lkQ5ND!m52RbQD&6!< z2LR$jHGcy?w#5L@N`S{4b>CO^Ou(wx`Z0_y#dBj>EbO&zO`8nqobo!e{p^#sm|cP3y}aI<^L-HwdMS}iLn&g9RU%&1eC zrq%M=j-tK&fv@;omvG%(MJuka3HeiMP?j$I*Bd2$^UsMyZF*N{V6nwP1(yd28 zh0{c0s%z^s;2kBVR0-uzD0_cNXxlATeNOju8E@7N?Qw?lL8YWcTI>82L?XF=gO{Yk^LL$WqT z6UK)cxvWL}bMja(TsK1<~u#;lm%86TEAC#`?!zfAR9 zbAU^J?qFe3tlsfRp4!CU050&$rb^QV4e4P2%{g|c-#T7sl^7Xt$^!nx(@J`=BJ|LE z##NG*333l?hB9qF9TBpgFKU|e5|t+9gy^?7gz~rbn+>2LK*WvIa;<>DXXp@sieN(f$2DW;N13y_>Y&hoPj;=b7Q3kClf>1i!$l z7wIQ3-u$Yyb*oD8@&?1mo=|)~f(DtFL;X&@`FVLQISwMMRY#SL@d1doVgrJwy2*s zgAIKv%AkC~?&ZaZbCZ>17M56w$b?#vbjqC+d{3KFnt$^|eoj1qE-!0Ll1&+GrRu{C z$fV97j7`DluIB9D7ysu|4VnUV5%5Bp>~{vo%cB#%;SfE|M|}b|5?dDJ=OoV@qgR+zti}?)A&E7`cFOn|GZMI;Or_JS*R^@s&ZNi92-F@ zZF}RNl$C#@=VaxzwwrXAffCJB`9yAYR(8nVf10b7?Wqd(@}(x{WpzpA(nZzwLyn97 zA`ditw?Q7PE&1K~hY5Qw7W3emO*?K`%)iPgn=J3-?NNNa>3VkUNH*wHZnbt!WPR9xV8`YYjZN%Vj{Ga;>*{HS#=wzl2F=6^4I{krzy&KuxF<6LbA4F9MP+V?tahIQ{C0NPZ7d4dmA5Db-k5t{CipHamMyZMThLto;@J%!Q;1_L+zT@7I&vF4PCK& zbF=MZyA^uiw!BskAZ5V-FY9^SXN+_GH2UPO~&n^yRG8*euH>~ zqqIq8rdRSOx61;{$;%ATCopJa8e`>^<~TlZi5$j!*IuxW2Ph=Br%vi`!0!qFUaxlk zf@{!_Qi0p2_{fti@D23^Aae-u>siHb^AG)d&F$M7`SZc_-a&ziuw}3Mg+}GuEkA^Q ztsN@;NM9V@t$1x&o4w0XLe0Mmn2_tGQ6UkaUQw^q8fBDAT623JRoJ=_e>8f;SuoekZv zsPtZKcj)i#h0CU&dj{}VOk|RKUtmz}$zAcr89C>2tzX}`3+=0L>QxIeh}UL64}wF6 zYX88z|LdNbpW*w;k9Gh2!%0JOpi^^lO>iYe#5v5m{l!@Z-nriIfx`$U@tHX5H}>YH zfMil0PExERF4{&;I_mT`i2a$@+aN$U`BbOEW6W4+)!SFWI>(=;ZrC2OKuS1mF>N*G z-w%&$K6hnrXr)F#wZPIygYdOfg$|&KqLvxHy1mk4nMNyXoOTTsOskLjd~NID z4{6c!a<4dojCYNtUGM+yWu!WOf6Vwsjo_EV)XJ}aQBV6J2BWnLJSDgx>Kf2 zJeaHK8rmne4Pv46g$2MAcOL_|aKCQGkNRiFIL@jqz&MkzNV^C7MXu>1>0_({h$?uh$7gu|$B0k&}S1sHe$jW<|I?qTzu3!89 z^~0dwu1-K4`<$;n zAf=6fl;Uozf9k~|-tjY4e{@aYyHX*lFg}lPCQCNAf4X~R5py*3dzO&SB0GHOfrrr? zB)sFT{rn2-_FUaqf*&;((ObwRZiew;BX&vuDH{42qb>0D3VPC%ZbxgWY#U3mDHC=pl0rBsBrERv2L#(?3*Qx zi4a}gf2_rz1mB`)ci8wB0k=Oc4v`03= zVU5ig+pY6`X?O3J?u5pZ|W9)5z;;3h?AHgbj|VcpobqHDiMV|O_NLEL0w*Q(dbsuENg0= zuMC=lqyu@pbb^a(%eicKzmskx1qp^_3sO8|=_@ zz({FUZ!t42OMdSyU2OAkes424#210hW3{K83!!>H zu*Vme#xoe{dHVK&MT1y7TZahKPY2xpj)GLo?RpRJB-r!zek(@{e+ZOFiDn0_*=>dg z|0;{j3~v5l*%)#+IOv-S586ESQ~Cpi+ycY3KPqre3Q-igdo~mpku@*m?J1qcGnZwl z$YYdyBOHPuP+A^U?OPBva;?C4;t4%`8$@UKAJonN;z;+mZoZ6PQwsh5z~eG&2T~o{ zu2KxCh77*GAIgV4aM3Tq>I^R=tgmWn;}kPK=L|5cG_K46Pl@aP=Got#lJ7GY*=Vt= z`e7=_pZUD5pC6C{e0!Ul>BqD%20%Zg5VE9teus`OAMDjsJWC<{rxLK8zVWw=YHZ zMe0p`;q@Q%bK8d=1{v$Y#5C*<9{TUO`Qy`~nG3A1_jQmBy;Ft<-B|zTp9tc?U;h&+ z>>mI0M1*R0E=AG$`1(0-%@euSgPmtuWB=w!{IU(Y^WYV*yq9}H;1hrm8;0=y=aM`y z*IVy{z%?F|$tLlLqP(MC&UOtiO-HAdW${lR{(t;w$8qzwfOom;NG9#?^1rnN`7!{u zsI6P`Z`j%ym#ywEdphU;Zeg~}Os_C-G_xh`{|zENSOJK{Hhz!be{2zO%jum!_m{3j z^xqBn)mIq$TTOhcNwBDC}pE5)t4`P$^{x53%CmH_a3;cgo-emLN zBtD$4YeELjDF5}K z>Nx@Gd_o^C>%*D{vBtUd%(GRK=;yIwHc8hSRG(`!q|u+8zDc&XcbW9$5lW5u=#f*@(Hv>BV7h($XJkY|fcGT(G( zowf}avF+4p3~FgKA*`}T#*YOLo(RqE44r#Al0RbQEG-}5dq<|&QepY~Y54nRzn)lV z{Y|xZ8WsFo!o*4yG(GwM+yerf`03Nz1~M)5sAKOll|Z0p1|dqHqs$!y#zvqcb-w6+WLa*~Z;q zVFHdWWe3CSS_{Zms%ge+Rhy7%CyJA1ClCqgh!0pBrwuo)-=t=!+53;Ih>rf%DH=Sy zm48)-4IS*B84B{9j=DM4&6w`AZAz1&Bgf>aA5_kY1+;JWLb>lVF1`{|s_NeLY<))P z=)wlMGK@Atzu<-b747&9RrIzk4iudF#O+B#sZTJ;p5zXj4{y-yId=ZfqI2*ZpuO!) zr)my#_kQ(qcGZ2k*_1KsX!>NX(drfMxcbY+on_PtqbAOTVzFcOi&>kJ8TK0Y*kmnY|z#`_`cwDVB?r-U~OaTU^W0Q2cXyUIsn2FT~h zp*>F*2I8`xOO^kSV7E9V&dF%62?c{aS31phv z>RrdFf@9u)brJ6aUK8c@0h!#umhSIH4}}~;qHU!nkCKE23Q<<8zEO5Fs+`^?G=z*f zRfruioSCMezhXliH5VUS9XB|1yN3_2-B5 zWQ|YDQrB1?O)_K^pK;rwFv9r6G8q9-*~u}&x>a^aa6-iD*yR52*tVOR%1_2Zvu3W& zc@^N{D$f@;`&N~1wsbAhh6#<8(DP71ZLTwr%X5$dSlCjPkHYmiVNl{4K|kIA8R$W@|1yy`;pLE*>Cji*G;4QPM3-6gcqpoD zA%XdH=;=7S0JbqkE$uDuEprc5UwMnq|4whv=U=!-wpi``a65#_i;pnK@WU%j+j5Vn zbUh4DO;Hv?%P*J6I2%Gfx*#-s2h)iK1{03>7{2UKt|8DvH#w(Jq1Gr7AMl+R>FMZd zz$>UpfUGmJd?(u&Ib3PojEtDwspw@jTM{0;ssW-p;?yt_Ln5|=felP2w+U2o#wV&X z_k>WBI!O^J;X5)WI_VYA^Fel??UNZI>8$_Z4vf3YBbQZ3Mv|VHxBcaFFHF55#j$ev zu&O&l8lhkEa>hF(Q$Hy_wQ1{3VQ3>iss@o_-v|At7eF$gI1g)g=Go7sA9NrxnqtX> z`Pt9!U~T(}D+?=(P1eT!obi;dNnF+VD5vBqQ(^hQB^^AG1tyOtC^d@SY74?;R;;%EE|B3zxjJ#_C5H% zRAT+4Yt#DVn`@A3R>IHf+m=2omF#r5Qa}&Ki0)y{Aj>nsAx|ie&;q~%6>`iF$Y>WCI&rK?ll#d85MJs*vntpVzXCF zyt}+GChL+^lhO1ovUZWv>H4{6?yp)!g60W$Ov94Ird{treHlAJEcsWdI6AtB0Xxjl_XDW&NQLu^5rtAq_${I2Xy-%#0E#mj{Y1P<#9pD`>!fw)VTw^>Z z7|?jNH9c-H4IE#5-H7c^X;z(}lTn2bqCKkmF-5H?6HAYtA|$2ha85%JeR~8|;_J&V z-zH{P%(ZlqpwgdEs^gXgo#5cKY6hqcFwrK}8J_5BvhPK?;=F*lJDdPv6O%)GcDsA? zLap0VuHHBpG~cDf)74rVu#!{ZH%bKh^(NT_o;&qfutQOpM_$m|iM^DzbG?0)5UBa&vc~=%y)f^bLaY)xU%QZwC$> z&#l(inZ0zuR8JNpGfxx~O4cUEHliwyU%BA~aAY4$AUhjzsL-z+()%V*WH1X2%V~F9 zxLm7ScGsFL7`~bwtoqUkLzw3!XCkJ^JhSMLg3rAgfhkDAVn#Hyqy#` zJo4d4Vq*BBsj6yjxi-SzUt93V%O?^}{>3iBxy}2K0RjXGoCtoO@}oqJ2a3CF1qh{0de+by~e!r@{tJ`=+XmjXb)Y)wkTqbRf%i zg^zUZhPxMBDr!}PjrnRUPZjtrX0?H}RnI8>=;IV@&bv*3tVrK#(ok(nBWbJDp`CD_ zfe+JTXU^poxM_}cLoAC;cCJ#E{0|@UJQ7U$Vo953$ja#gwfZ$-v1AO%j}=CtwGr2| z&#N|Jg%rVuIu52;o>pTQ9-1g4KUA}q^)ev$H4V(~fjX7M?32%%6VaZ*RqMooilwc= z@-=7uQ$unRQPu5K{Ui*3}6Oy`2ynB?|yt!|Zi669%U zb-m}0{QL}r==faJ&0EkqTXj2}7hY?5Q)n^ZD!O^UZEe~^6rrYZUURlFU$}c$Ly(3_ ziB|?MXxYnjCNNJ`AQmjUOp%Q8pSu6HWO?GR4%?Y6LY4iCcM=E3034Xj7!CXdZuT&}+B8~b>L-_MdEa&uUK zRZNF9ONUclg`M9~Fx9qVkD?CW%&371P@9)l-X`pf+=;$XWsy)n5u48{kLA@0=()5x z>3WGz(0w~n!z;(-vWd)(=KN4-w%UUU4_-)6*6=e_A(?rCOmG7&JJX`evWgXEgiX4f zhDLe+rb+9T1e7$*wX1AO#y90 zZmA=zu+7`YTZL&z&z{Q~BiO+A%{@m9WeECp4avJPf!@%L7?qfQ-u1>Wgj(Td9g1HA zps;m;5>`&83Sm*zUWKbV7?-Xlh+q4zctzm)8OO?R?uNoY8sGBKlrNksAl&+EmLkRh zU~p0H9a_mfB9mJH2=+(A^Ux6;N~_uV`k3R6Ta}I#0-U?fn+lQHFAvCNKf`aD_ax-N zdm#!kd&GQ4)-aU)4Fd)}0mNjh@%XcZ^^SmF4J#NuID;0g$STB`G&D&6>t*b`8Cy)| zK~|wKbygm<Pkcb#psSx*cS_wLE9em>k6kh8eBlme&OZ3f)XH4(jm8!J0Z*8r0EpifgChy72M@V{uN zPspzup-(h!HttoKD!KjUJ>^~yZJ0l0HfT+QoXI?jN}o<-**3-` zD@X(Cd%>;bPLGOd=SzIp77Zt|z;}h1x7VC_A&|>5C0!+_q8}Z-Ygn^e)2#WI#Q9&> zb9(ijBC*WEOEHuHWrV%7wvQOId=gBJwt1OczOM}Gp}eCs2GxP}E#zgu=g(-H{?a}v zG8Hm5o`%c?--s>&n%VooFz;P*<;P-uI}dV3z&^jooy&ELr_K2(i?0kBRpa@!mzBlK z>QltTkOcnw0vV9#y9O7lso!8V+p!3x$knX7Oqn;j1dTJz=E4VkZm;o3{S_v+w{mIN z;kkWXV;8S(hgM&tj>p}W*ByyoqpJ8f%I~%bG;dbT;wZD8gloS6&2%=QEfVeFH8d*2 zg)-^pJjTb5Wlc7;B78yLomiT=hXzh5zWU_?-J}uy^u`*L1=bRY0X~N0K0T^7N>^QwPI)0FMsweazvA8dIvVr6cY97>@H~$j zAvqiD{bhepCI!0DgI?KV|6c1azCf_r|4qK*}hym)*$QPr2iuCj}h@o*ZDG&9!!E5wY#*GmkE=!3Vdb!cscP2|K{LO_8 zE9p*$mwlMjoMPqgt67EyYGVO5w+{RVA@~U*e-hb(mY$Rxnpl|0C zIl#5U0VbpiGMKvqf~w#E9V7xGLDM@P`A?!341Vo*al4WHb(Edgp#9hJ3wns%2TP(; zZ;A(Z2q<-EJ=#vHmtF_}5GBjuK7K#axZTrnU{Xfhz)T41cuZUgk zb8F7RD8VSMR3ZI)k_jkFUx1Vr9DMD_jE-Dx|0@gYdgg{rGg!*-ssH*(iYRz*PKa;9 z@T&1mWy87W>-DA7)BU(!Q3Wx*U)ZWvQ4dhHax@eQ+N!k(W^=SvZ&azaH(yEOT1GRozh$7nL7gmc~XOFC~h+23|3 z5|UVtzxq$~75Js6(_PjN(|%u6`JxDT?0P@)QLJp!Br~GZuzBhdl~hUumsi}6Fi^?n zc11p4j&kO=JAn<|f;xmICc?~p6!00TPRm1k>Or5VZqh`ZP*4r%p?nUTu3o?H|ZaG0z+PTGmbM@#p zR`oW^*_`O?V&ulAzmLjoijwxqYgC+j;liQWs^V6)P8khVzj3hM>XcrRes;8<;+ zViyDy9py*#JSo^Tt?Vh9{e}mUMQ^beuW6(lwj*c?SHAHm&hTEBzx5K%2}1jhCxZaH z|J|P8X82w2L#WpQZ#@k+6NpAbqw=(zIlzQ)~?9mV$ zWHXaV_-1*4-Czoa@y1m~rYzh_W6CvQ9^iett>52I^WU~Hh|JTe*INO$J;{A4{Xd%X zOtV#;$`Lbr>*0WtTe#c%$=B2g$FXhItH1}gEbIJXFtYEp!;Fzn@YKpL@+7ArQ7nD< zYi*OQ=j_GU1+!`ZWAS)-&tNk1tk1-Ggo@}rw^|P#Xwxk}`t_GuM4)2O`>TB;xbnk7)!>Iuq^_c`5IeOazarUV)D} z-SnnTCIEJ-pf5kc*=*>u7znAhoSX3!^uF2Tn?KA92e&@*9U^8Hg-v^+j0t_)n3REK zx0#U)wdC$b`=E=J6Jz0R@gHO4m*d_OF7dqIiYDsBd78k66yU6)`$d(svHh&$wz?9m zd#&JBv)tEk%e@l(UtEwQL$@R#Rl(>0a6)?ZlM-ovJY0*T-}X{zFfZ+8`TMeL#d_T9 zpY-ac+B6ZD{4mNJuoCQE`b>>~!mCxwsC-QFVQ5Vd)%cuo6}5aKmKqntJYoXOK;q|7=%RolR>D6Wq>-+Tudnv4w?@)K9`@a0DJOj=~$HlvL&Ai zl_xC)OV7Z*kWodIxbowdli-Z&pzV!Q2z-{N8~^jxDL=4NZdvnaZw6MDmQr882CCO- zN%AKq6%}rQ5OkPxjYI$T-Lx=~ds*mRj34vvRjcAFS&H3!AL;N|x@X(-`bm$i=i?tg zz233?2{b|eDE0iaC_CNm$5#w}eqt{Bl*bwC8ONo_xx&K1lP$4#sXTpNYrl>}=Pw58 zW-(WeijRHz9{FCDSe6sNB8k0?3A2B_KmuytC+fwRvq;7hF+@5SO`3C9LzC^jX4m-$ zY488-_{o7{%{qi4vEz(TeWQ2WV?LkV`IH$w=PIY+rs6z4^eUO5>_@vF8TATuQx2&SLkB}GU!yW zpAWkg6T+%Fboler#@X0Yt-?Aw4x1J%p|eT~3$+xPlj=3K=}3k8s>L*&x*Q*2_Da;y z{6wx-dkj-jM&HU^L=CjDM^U&J-N)(KluFg>Vh@+DJ+TjFE}|GjK%|mCml*QC!i@OH zrdrC0>IHRAI#p9|dxSjHb{95Q^~YIQMH8#eA+CKMv(aDXJjF9ESbt5WlwENPFM=!NBMoUTw@ehj9Fy?ot;| zWy|R|VOEQ-K)k2>j5|R_uKKQxm0DUYow*3E=1F1y18Bhc%#5qPInKI$7{do$Z4aMh zqFU%LpX~K#5-5K=VrS7t^r4oW!Blx=O~}6T7QbG5%ZIHJSu-~8Iz;q0{AbTTI~fO} z8q{EPK_^-Jxj=^B4!ny$dr(Oa4+j&7SK8LNPWlQuZqP6n2h%@{MN{d>#S>tcZFx3L7xU+o7J~m+aP~&%N{FEFJ0ssi=~3d2|cJg zj1va&YlAXXn^-6iDPMJ_rtlmhzN8Clw%%zaRtJ0f(MnY926>1k8%@5(M~n-%$|hoK zi)gd!Oz9MnCKTvST^A&Y0cBG|tC;Tv5A5YfN*=n;MljePi$L&ys0QbMTv2Lh@zz7j$uSdEmDF6jO)Q2y_@19%xE0<_ae*lJ||4&Q&z-R3KQl(P5idTSB?H2MB$ zBMJA=^{w?Qf06ue0`gb_GTZi&P%-fpemq!J=L>(4zx^#BsCqM*UH$aD*Lm!X{Erhh z(fE7V7VH60;@~(s*#}BhpJl80KR*kjR%<#M6uxQV}CK=fl2`Ctj#`Bw22Aek}2@9st?dLU7$yk(0}kkM`L8+Yiu^_`d8?d3LS zu|`P&knqbrboa^k7_pz!*Q_Q!NqT8GBmI$BxS5ea-t)pz=k|&BVXboZ3k~_n0$Ghs zC*#STk3vdI)77p`k*P1W!i)+unaTJ!3fRJ#<|NjAj~dx7d>ehQ$;bCr`_cvGpy!m> zln}Hm_caE+W{YA~q?V6o5A&&wpojZ%8FIBdN?hp;!^YR0IO>5@3rdmG8QhEA`uSBL z$ve^IYZi%1tmJNQQW;_;UuSN_ENi&9Y^?N+3XSx0F8A*;(=`s+ls+fJ+@2d?bxrIe zd>yyENai^Yhv@4{NYG<8-Pb_rsSZl!@`@*ZOgLh9ueyCKvvKlY=LEheq@QbLEZo}N z_d4qx-4d0(W>*8#0Tqa&1PA4NQH3G5ES$|Jp;^*q9KnKbSeo7ywlTKdepPyv$nx}w ziK9IWQ=&EfeL@Ao0D38CNc34^>b}s=OT+iAy!P(ZE_<&2s^#$tp=Ot?4L*MDrVCnM)zSZ)`*15*ig@ABmgE?!j ze|klfAPfqz{PBfmrTtE{tW%`T;E6TjYopj)oljU~nqxN6WXO6pJA1kSWWcG?reEky zjXHbfPiDO7n=1k=*xEvG0tds7h$rLSd*brFDRivcIqAjo9^AU!h)Ed@hntbipRQx= z;YhL4pp8uT@GWW&7;WYg*|BE z1>5h4Yp%C>jmqGG6D8?CDVFOAh}3X?!n3+4WW$o142S#(9;~>-B)=%3|%6ih{~Oz-RDEjL_HVB zz;h0-agZ(7%Uq>FJt@FqZx7`Iv`=7kwSvQ838G@mL%q}kks)a6;Sz8hn6clnXetk< zIrGe+P4V0%jo-+1P%CZ+D!P7^)~E&Uhqn=*T1P*9TLhHTs-U)V#40Q} zK8>9~VK3q)pcGL(qY;6&X}@JZ&7|KOvD9eReFNqluYi6g2AMH^RujKcpD4e217V>L zzBpPP@4LTUl#f?ix{3!8QJ7S!Xl1}8xMgOV5RoKjHc#kFs+j0X*Qqe7;Okc1pOV`e z7gQ8WIS#j*t5)HEE=ie0_)Sar_9gS1<`gme8EBS+2wZxN2J1*Hwe58_pTmfRjb??- z{6zP*z;kgN?rYlUq{2}6yno@m?>s$M0glea)Ps@o)8fl1QCgOQ^K!#lZSC?~Nq+m8 zJg~2px>B`%y&ZWXBhC(+Ppe~<-E5uF?fJ5Q0;i6g6MF?X@bO6%D$M3o|6-}c;k~D+ zIGW{$X!jpq_&&}LdM2~7joVGGjaBB8UgnVAep6U0%=Te0NPKg!E9{%t>=8YT@jRVZ zNS4z!{9S#MN4D=%iiA&ZORu`sn@#u~68DqK67u_W6zywMB{Shny*;jK&UU<#ec1eO zw7-ZfJ#npY&i^=4<)fsw%Ovb&T62!bKbjpOt_EMJmc2knsEw<=G}h;}U9rvW&+Ia4 z@{PA-)#>|~D2|0omYeaL6H=Dgjx=QHx5osBr|x@0IRzZxuWgFX7naJ_-S5^)ko#f3 zkOWF#K%z3As+E`FNn9lc3Da!z+a)mAm9Br zMxxYelC!;VNh8pk?MEFK$MCVl?Z6!zNn#y6nL}9>NwnBW(lhUOm+NL=_hoAld;E(6 zEIv|K(D!h43D--6WpO>j_3JyI&a0+NOv@ViMh&gZFXbc4kP@wy8^aLvFt_z*flUgQ+Og!{* zSsfFgpM;rkXxHc(+$XRpOO9UQ178~>r+okkL{iqPN%hor==F~)lkM+YBh7l!gLpQ9 z@I+`&esTQ8@p^n#Duuno@oLMoi|a_Fs3=UZaIB=PVs#+1??ncsn#a@Fxt4+BF|5%? z7Ppcn$Nh1Z)m})4YO7fcpIVE(Y;TlVz90+2tDE$5y!8;aQ%)k_mL}>YpRN?k5OQ&|>!7MFr$p8*C#5_U(WTwV z+0qs}C}T+lc2EI_`?x{9cx2dX!|y(v0Zw8Q&z z8a$uuI1p%WmyKvdP)53Ntw~*726-mG*=J4QEL`WdihtlndL{@T*IifHTOU^2a+)77 z`Wn+IJXh^OFDh0b(O2-pobV+#R$i@yZLQ5oq1Z_3URILCcDr4i~QQ|h;}$?mGBH(43YMkRFWxIVi;Ic zM$RFG!5)IR-nh4G{@&WK29=aJnsX6>|*eO|~hl+McZM;sEQhcgisg2L}S zJUGkHq}__X5|=Fc@>GUMY=5SnwSb!sdZKfpCVnzg*8e1q^=$@UNu|8yh)~qbdA?H+ zf+X`pqQXH1lRhHzCetax<<9w)2nhM1m`ba7u4SO~n3~ zrA^p$$g86LN#CrwoT!ZP{M>Nvf_e854-&8hP0#v&G-#P@ZnG^9xb7y%{I(^Ub-*9pTyZ%f4xoywSE-ItzSn ztGBinKVvfNejdXoU(pRw$*G<#+lNWXHDvBB5jEnMV;2wCPQ69sX2Ag@T?nu7J?Jry zo9FxP0RGK_?FuZ!&5NdOQZ!vPQDJF*`^z7hGV9IOof>&a+1X4Nq-37ZT&pXNAaZ9^ zTI_iPg3`PBMN{|J&WZ}O)s31PF-Ey9mzy;eMr!YcoB4Q7_f~pPpZ$58*vH{M-Ukl; zhskKs4^gbyhpOv$_PqKnJ-uuZ&-q{qzjTz{JP=fglQP66qTO>oehRtzb?>cRZ{2>b z5XWzQvgxp~EtxVi=kihTne~@8j|A7{pj+0>_!@%~n>_lo%g`-?c|I`t-8NsQaun7^ zypqNV{A{pKn!hZS5zmB+v+Zb4BP1qskJo#M-3+c-Cvh-6iF{A&~$KL z+<6?6FxeS)>bwM1wbNi2Jfuvy3|OxUT9|r-+KDkY^dQ4=Fi4f^$MHhYiFCxbG1;+4 z$}F?OXVccau1}m2*$rL+Y2Y8QIowX#sC%3;yi6_7^s6RZ?2N?iM}nRzL#aZY=kj#P z!kY1#SM?LyX4c|v`7XFJ`c;}MuEw4y*`4CDmnjVRCeQAoL5{!rOt~{fVc~4HPre4d zmvVVLAo^+a3H^2ZisgBVSH@AGTLNb5bHsj{#}lV{B`7hcyf-_Iz~+54R=yIQ_|{3| zf|!095E(9+Prcyy>3PTCHM%_X1~@XXrXzqx-Ra2cNYv4F9PJR?du+7N{cO zweYtbqZeSBxtm2BrhdAl8~LlujwaBS7C<(BW-=%8ww~%k$$V|Hm(9jfR(6Dd&pb<6 zcXw7+c~F_bwoKz%Z-i*B`ysJqv#1OACP^&g$ZuWgg*4LeEi&0teBXS*m&${}uHoiH zb&BRgHixGnw;BBYooJs6fFluH(QLHoF7)?p^=E?ATk-Ilg*f=iGO1(L>D7| zoG8a5mLj?AiHN3xV_t5?F+^-He|?2Ief#oVa;A0nH!e7^7>A7T_nb%wO=Iw!q8o;c z?+PxpBN-xXXBI3rT@EkSH18NkCel4W`2V_!KsFmrk9-{WEv(>2)_gXp*K3-Ow>ae^ zPZ*@>{I+cb>wmc5R9S4i>(1`aeM&Z2HB7|s{c&O%g+16BuA7%rN?w2axofsax{H|I zP`AFNj*CZlo3zX7{NSA!;Zvic+#y`~8)?s|<15F*)202D;`Mi=4qqK)h5cW|=-m%Y zueH%m-oD#c@6MiGOA-2*e(oOef>$hq%(r3BKG_kE$>?-&_FD%ph+neYVKg=wmmpIf#_vvmM-1QD7-$YW^iXk#w;u9O8C^>O%R6eeZCYPJ@nE$fFego36bdrc~^@@Yp(dToZd)aUQGS&D__IT{YTeX z>h*QTZv*oQ9KFu=;=>ZVhGS9@u9G4;Urw}43cv#E%NIwNi2ZFP(v7(y#vZGos0f<= zD`jIZm!wt#tK4zI5vhqIX*cppnZo3e_uOgf8_I>MULC`r_T-}DubDZW5o-iVks^mX zO3^x4<6Dy@`N47?Cw$79duby5WY^K;BlCLXTOyAgO)*@%lxVb=$V)8o9gAEv5+OP4 zrR~AB^QXz%suaFl64EU^K@K3>DJimqc^{U$hr#VyI^@AR#uI&JAKXxtRM-0Nq~_(x za2s1pJ`4?J%HbNqVK!@6@;TK6;CtWE!zwJT$jAnE?}tx9nbJI?@1JcPA_e26c9O8b za`e1&xqIT*=Ps&7oeMi(OT2`wWrSufHk|dn_)=}kI{l&O1N%6+t*IB77bl}D->aL~ z6Z}ca7nxo2bq4KKDFRkM56SStKer6*GqNXq^@a^h*mXehOk@tl==&A!ez{ro0ljO; z2{R0!iO=Qf@5vju?i+PV!`YOLO}tP0W6#0&U)r0Jorr4O72Y)PHO#CM*^1(XPc1(i zZl+goBVR6)9@^m&wxpYZl&NY7x7EgVq)M@#SjK$e9Fg1J`b@oE#E^lvs3i=ndvvUZ z3cwxJQi`{(J9l_K$|*G1#0Onq`pFO{)=YDw@D zt&;)%$Fl!y-#aK8uKKJkH1`oG)n&{9OH!F4BnESkH42n#9T1}_ZNI+_6Z}I9@9~du zsxeZ1vIFH9N$GtzFlNkx&bvbdW!$Txne9T|#XuS8E;z`U>|v7j{W~MbC;cUpQR`9Y z?%jtijbC}Q?2lFR$^e zqMXU{vx)U@T#juK2lhywp|}oA+GVb!fC3@PuDsO z@|SHgJ}}#fy!-gIs7hn>D-;8J6}$YHNZOxLG^p(~l<+8^CaR9un>Ct+*n%s@XvZzC zat0v>De;%@PoBM-3rS=oZCj?NrWBh{^*SMY=N)1D7!-g)g-uC@HlhtZ9skS_o#wZ# zk*+Yf_fC+(1_v@@;6b5wX8MzTsAE!lGQY@#b_qb1z2xLfJU;BD)d`RUb=ar>td{A)~Se&FqsCpo#;Na@|z(PKE4U z;r;kJVayrQBn+>Gt$}Rp?)@ildBDe~?`OH^DHj&o?(flcivqb|5Y5l2jv*=I2@*ON zKR&@XC#q{qhj9%Igw0PXFAHo;{#M4{c^M21%XcE$qo~BV zehoaf(-Fx*!(%F{=znM^*Q7+(I`mdB+bIb1WW28LSK~#dn0W!)`I4;*c|i`aMuo4_ zH7PKzY`Y|N>kX#^+V9OL1T=B{^1eb%&18Px^hJ#meEdtqAz4l2^jGjQG95Jcs64Yv zX6qrw(h!!Eo|d{vUrSPigo5z%(Odc?wf3$Ar!(P@aI{th1i9gX+X8eeCe-po{=hsb zC6z1Cmq=y)Bw0(;Fy#%wtQ6#XgyOPKYQg=P{nwwt<+DsOtV6GO+kVEg4}Hm*+xNAh z1KKw5ZzWNbtDj-=FmC^QDUK;}w%=Qdc{UVC#=yDFp%Zmgh0E}YuZ^N)0o12 zWIy!MHsMm@Ev&1&?NWVk^-|Z$GHFUj^DGc!77`RcBLnx;u)_M~Fzzo3>Fj=#qRhoX zcJs9#?yD9zKA8f$ydlTf^R$ien7QCL^U34)fgdb0g5OoPGrM+ld3R-BO|lPdLDsDG zV>iw)ukw(rHTNAs!c43x=DCNNnXb5-A+yD+tP?-+CQqES<)=1%&O&r77e70kG9WS8 z5T%`o$;KPr67|{j;^c^%$k{dj`(hJPx)#EbRPs@6lfx%c;ucqm@8@6#+YYPKn-yEn zTVSh>sH-pZnJGxYJP%+ygg_uDPaptB3|j1Kn;sr28@3P_@IA}hiS8Bs$!`)lbm7T9 z%cIqmHH9z%y3pr>9dlDR(%o--?=+RppqUt9oE;B^$lT_GVr-?$6bN{2OpC~d?89j(*%Ju>MLqt*x1z2lIGm5b#0q3%7-*vq$T zG~U=>W!W>)I^%6Jpu!NBdDYGzqJxQRDtA|x7S{_%l6=chMSdaKqJ5^(>7diIUejBT zUSnO@0Pfbpylo>>c{+Bu0qqAbM=qf6(XVGdJI3UP8}Xx-JtM1^b9_36Y`RN}t2?W2 z?d2fkRcs^}wzK$3ja|ykCMFPsOXa*M(gK%2Mq?0jMo`5`%=K{8h=Gn%6L&Ghm2R6mKAxq` za+tBbu-;jS75j<5u4ozGGu2oN?wekX8+ZMs8Z&>0s9F2zMKds74{m4UFC`a)RJZO? zUm?sSpQERH{U$@+ezVe6m;&S5Sr|>POI^KKC#8_{dFj?F=7tkXlqoQMM(WUd`>JI# zim1xfH0CO>_q%6s7!aSdmY`)v*RNxY^^%I_cHwktcsKL` z?1E)p7l%sVDAg_OsA6xmp1+MAm~Z+1lloy}G7o&S64S&jhHM9f)!6pH97!(jb|eH3m8TtUY@j)X{MeckA1vT2O~_ z!Ziki-;U0yi-O$Ed%s~=)cZ~=+@t+y#I{;EHx8u9r0`+T-Ugxx+SFnN)4b zcvUjnsWb$J^~qqenMhH(@H4DD(!9cquQHEDc6b*Na*bhM^1oX( zerTlWb70$)Zh&~b`ooMY6o zLOhxfuaD=>e^5k8;Ot<=q->m+hbJXBv4QVfz);HEyB_m*LY{jO%YcS}qz!EKPXJ!ICi+=@e`2%lN5gD>@R4^i$K z=7Gj=`BWw*w$EkFNxnsQi`Aj)@3kV%!puQyYJQdlt&#bwMyd{lF*P;On^;DEvT0u|l&BPDy_OPefVvG3H@n!>3rhM#_V-Mn)O5c+97qT1;~O6? zJ>x#UM^kb*Og zs*gokyu$mi)8J&siG-o+pG`hN@<^_q-Q$AulJ-BWXxDgc*br9T$-#O&e(zlroPCt7 z@W_+HI6(XL*IzO{4s`Z7F!BsTooVe$2kXFL<>S%4>SI$xKdE3tTXnaF@;pAdd)hj9 z7v0UM>UX7Z(ySQG!CmAadnL~yqAi83^EL!gAj5l6*?B08@0tAcW!OD3C9N5J6k4_z z|5>*BMW1>TWMj({n- z3@sxgJw&>I=%F5ABJfr6v2wITw>%M9)*(-z|8{1KQ&m#3iE;la@SpZ(dDu8@zUCik zL(h)uNaB1%N2$Jz-6*thRJ{h5Z>+#I?2o~Ufta57t8o= zMLmVW&erF>+mAe|@>349krBKt*o#?sFLmvFmB70+T7pMcK3sOi|nU8gvag z*Qru)JzqtnP0Mg|Wm_|;WC|4!ME-deWZu@k{;bxrsl`0%O0ey?XE{ueWn;MDsc`^F zWI^Y~*9)m_Ria?VALHc~R`sb#{p5Wiq5}}GV^IR~vD7f-Lh2ZaK4q)xEIy}&$%&Mj z-c@!KF(KF zgZ)k6wx3#mB2busEh1ZVooTPKca%11ge~m| z`^!6iPNdTxkePM5${f5jEw9E)d3xY zJ>{6j!t;#qHH=ei$<<_#FMaK3f%1VZqsdgT`E`--Nf{KvP}CfB6zs1;^ANW3@D>^# z<@DH)Z8e|f!vWJcntt5@ht!C)eN*yoH)2Abg@>p(TcR()n(pT7yjNUgYgeB5h5%tu z8KSOl+o6?HNvHG(cMS-IZ{dL|muU6h;lSvk7#`kjG!<+?!5a9I`^A~j7Gp1(ULj^; z7V6Md*|13kT2bu0Oo{Dvm2}HMxHX6NdY#e26@MkS$?Zg%Lkr|#Hg_zsB5S9}3UdeskM zdBZEadtNjUUeY(WA>6x~vgGbd7k>hTbGT}|M6v!R0$Xk#5xS|gSK&Fl(uv=<|1!yq z48y*v3Z?a>UmGQag&RU7HFY+r+}7~R^~%TzfywLp%Rxbq#lXx;X9y570xtgi)H?~O z4AXV&BFFhOsLE5{ziLgl2SIYPF_d^$i8Ke5Z(Drh6Oo{i4dS*d_)((m$)56>5E@nr zZ~Go0#F1P0HWeET!GRH~WcMVC3d*I&>Fip32*;d5t)B?@U>xQbC{jCMZL?UJ#DdXT zcf$7xl9o*Ai5h;x1@E*ke$kpSy$vc$9rb&A1BnghDiq4i`B|9zvZ8wVU<^Gb=p%l0g3D0gmuSl>*TX^xZ6S zr?RqdSvp3vq-9FU&$Qk$0nU!Lx0JR1{OZ2LmLz|YBYyL#kk9PxvH)%M&BBx#)Y6uq zq5eB0Y|)JxOuj@6N?m_=SLRcZ^hJv$jN!*EVWJHRyO+dDKC$_`F7L$-J}E=_ksWQS@wASM>_l@JZ_VuF;punFfVV9lhm!N|$x>_~zktfQ||@xnQ7g zlY@r*QlZSX(^^B`O4LARW4Kq_yLnL&Fv-_Vgqm}{9wU#6#H+AiJ3UoR&4kk{bbtuz z(xu2xP>h;4ZZ4W?%BiX!qpOf&hj)X8PRN+9@!#nu0i(z){J#X zj-AI803!tDxU|d6Oz~CoDK&o_ytP@#qQrF7B-%?Y!1Z^Sko07a=W;63M%;81Ib_25 zr0d=gJV1zS-_|l+3K+SCTyncKBb3J0(-RJl4v`{7H_|RY*g~B58Lcp0pZD60rGU$D zgr(Z!udJiyeZKyCfegu^Uz%5AcE6%B+BGL zzPV&$sl4axoLJR4mIS>(+p}jao{(eZ=$7Lo100q#UJPt+$I1=T;HtG&nKQgY2Sz(=CJ*`LL zc@RXt^Ae;j2b}L2OhNP=RkeaDUP}|oRmoh_yWu8RWGWYE<2-q+KN;u&G`)C^x0coN zCT!k5yzb$*vT)PMFldilGfJ7v=)0rvemZ-=W$s5Bz_0!W2yRzhV)`H)CS^zGejt9U zGT+tY$m_KC^e&mgwedWnJMK$aVBzX@k9UgOBr1-AeSEOyUu+v6%EVJ-2uQj43y!L( zk)p8eBkNs*zUg<6qZ0~E$QdeN{6Oobedo%PL19(LRr9Kz507$gzUbxZe}HJyfm=*O zVWS_+d8l35?s_&RZ*&o0B|4udVa`1lag3rM+llfgcDy5cWN*7u`gbFHa1Hmza}A(x z{I2v2pds7!b46n6ELTFW~NG82I%SlJa$9Yw zk8IAt!mqlr!L&1mofZE!q?pEn_bGjo&1vrGoAsyjzZd6F69pwP!%(mFk0a)aY z(Sq_BC$1Ot8^8|k5vd_nT}j{13hz1<{?br^T5{H+NSH$rq0PsWv)seJrWQD087_NR>R}V2X;HD zi(-bc4>|v^t;k-S->JyWIFsN-haZptf~ zm|(x#)ZgQ=hY zv8~PmXHoObQSkagB+xxvQG*dT-muZxa^~Q|mQ#?&c;=?Ok$RUiX*nu2#VqD|(N0kB zKy;sj@}uuVzSP}nBFEKi#z!r!Gey3lE$`vCx}g+jVbn7`!lF#@-O>ic@VlZk3PqpVPJoA!?Yy$PV&*FVm{whbZP-jIO#@=( zcig^}^&}d({+bhnJ0yPZ?xpN1>17Lbs*}K(w38$d(=^V7(AJ^Xn_}k>bu~CXf#@g^ zsrBook&dl_22=e4(e%Ry(q}?fTkHa+H)Z0Q*Z4@?+U4G2Tkeyry=^-2$vrpJyCBY)>e zXnxT&zP(vD(fe#?J5@JOSz1>I*BgWY*5KK`8|4WHLSN#c6ilc#d`$BcohTMa;fj;B zVFim2{Enkr!#5tcfjY_&ef5r`Q$~S@j<{2ET1^da-Q*FC==u%G&*h0)4RlvYf;;B> zDq7gH*>pkFhmSo|)Bn)zJd0>IjA?*nNcy;~@g1kIv`HX%bNe~MTfSKFSfB4rr*psP z)fw5oS>0Q@7LB!bcXa*mg2C@GCR1&VYS=emx8H#PvzxDH4C^od!%QRrJ>_}m|E;tg zTPubLE4@ws+DO4OV^ZpH*$Y%!N5!@;sV(3B+kb5xWca*lK!=q&G1EGpHYLE5WLMSZS7j= z+@6eSho9OgmcyB+UPcZNC!05t!Lkn*d+j=wjV;Zx4zFBsU<(9h898&ZSlMP`C^TZq z=M4_~cHzevU(C-<=M|>)O4S=b+i9aLS=!W3{rDKNJA=Xw0?JkK_7^W#22BF7EoPI} z$hmM*aNHxSoR&0RNM)8et#T990eO9@dk|nY$Ny}`9u&X1X8p2j7$`kk@VNz)cL~(R zI`phSVc=y$TgCSS&&A<8)gnz`JpQ)wJF3ioLKK0veZ_6Yh zPQknPZgw4l8RF$r(WqQ9jJVyYkZRbY{yyy+gdtNW-qv1tSaaK*jn)-JFIeBta~{Kw zclZESsqqA(Tu!5dHR^TWe4Tk%YoZN5OxY9sw7hZcRy5xp+_+VZGn-svD2?+-PGj)& zst}T4*lMGqOTLTKGN7aMFioJEbJM)-{`-_}tS5nUmLR&BeEuRX6#X_R`Inxjk;U>O zNsi)oOSlYUS9H=v>#bofY*EF9NqFAnyss9U0U_f&cE3dYtSQX)Y%jMf#_P(pg0r;C zfp;~&NP=~^Sw3DaJ{xK>mIH)f#VR=^_4dRaCDfoZ7>&DiBB1I=6~LEH8jtN6*BYY3 zHDU{X$6Sm!!-`^FopsavA-kg_O0@g8JiEX3zcNP*E_U_<^~nLAC}u6Iq$QK600eIV_|>4QN1n&Ru}X<&2197qZu z1TvCR$a5jpH6h(=SvNR%wc8b&MAg^qpX$WaQ&SuIy_P42c#%Y#lk`=pza1`{r+~xd z68H4*JR<+jww^ylYS3%L}&P&%;8$1@~@YHaqT4$>83IqU!dL(6jTMQuA|Cf43)2 zmx5l`n*EU{xM96SU!5$*-4vCJe_Hl1Ky;zJMH`WWp4MJ|Js3OYc_04$ttlD7R1;^; z(+bzOr$w#Jrc$SC!Zo!M0bU~?15Em?qVgiRk8B|yc*YqfREI>u&Y@cVoK^)IE{K=h zzVtVAr3PcF=2%RiSR0%tI}E9N2lRL!BK-isHO82DKlR(~*BjvQIurHQ3gwSZR{0DX zeOMuZvndhwv0|pKAVrY|Ll$fx5N~F_H=JB81+`3ylrfhsvCh4Gb-XST-yCZK5@_ME zRh?R(3QFZ?Pq%JjEP7)9g!h2gHwX=H7&j6S#pg>ek9Vid(wr19?F8HTBeIjMcrUmv zurH%dI2`5=OPX&dyimaM_0r^KPo7Osh3z#%iG z4^G6Ak0&vBxXb^|;aUc<_Ra5K+wY7|zC=A+FY`zTs=Y2AqqeacKnS zL|tje&PEtkJA~2xYAc$ay97LLGoC(EaSF?Rp(CXk$;Eo9 z%2Ah; zEzAKS6_Ywcy#(IQW#;)#tO!LHKRnwWt^}YN#Ov9pfV&2WW@N%dmBG}97Z1=PeKqBFH>u+8Bq&*8PqHhtWfQoPPaR&Tn|nn9(N2>S z#Nn@WWs!}VdGB>;AVhau*-BVK$Fbp?WW0GlAgQTBhO~?1$q|lX-5-WmOvHFGK2x;xQQ{%(Niktx}t+wdO7iY?_3a3KBG?(vD zw?q&zf-kp^DJUN6Kw{%|p~N38uSj*wMG~~k!-Kb`0)m91hBDX;3Sg@5cwI-WLXb4B z*ZvQ1!1t1Fy2wMRj7z%#qYx@nsdXCfSLFSeE!KpSAT*YRJk0I!zH4=t>F{?&aUj^G zrvwn+N>}@a6#t|hE>zO{htGd|x(s8KDdqo&-}H;S9r)(IjxYv*>4)F<*8KBdKcL;l zYQEkwI0DN0Z()69$vxGjQkuo4@WO0=g6)21AASHb4`Ao)N3H4tFw z2}))<{YAx;c<|_3IXIVTrZ6g}^Z6N&?#kQy~4(ya5j6YDB2Of4i>!2^f8`E{ihJUjzFaA=RG~7^U~{!G9&9vixRI5-WvR z|1*p7KH&jCqfFu?pZojV{52;EvcGwrZ;QE9{xt|a*1rw-TQV@pRuEvz{q5sF(MwDGn=1M-zk~OmsiOC=&w)|)J;8JM+uZyIoAiHR z_&qZc{{zGCW%NHV{0|I&3X1=M;r}}@5Xz>V?TJ4NIiev7QS*HI&(#A?=p+Ir%(Sy= z+HPd2eckd)FIU~H4GJ?(giDgfigZ`F`q1N*{#mad{&u=e49pYsj@2iH4L6)-z|~=< zS(V#oA%$z#wA=MNRh)`f8of&C@Kveu)s>!oKgu`_%vPef-~zr^eakoc!G=nc@zYAa zpDvW@85z6)%KayUuj3PD4C)SngvY--{f*!?SU97kmD!wa9*+DxV^}RaB{T*#O%|Q_1GDYNqm2b>0Kli@s#9i zWP8!*v&msG^~%cE`13en5kOu45q9V0PLuDrm!J8yR#h3MJ_FvI|JQ=SVgxKW#%xVO zkkQnZJDGEPPZopQAVuFw55eSy*U%1`tCNpli?6I&+a~1D@gYc(XZyNIESlnGA?q|x zXZwqj_#ozAHu0bK$bteb@V{2fG#n`G&z|sS{~z++GAzpQ+y7N0MZ%y{>F#b3k?w90 z7`lfB0TGpy8fhdYhi(``x;q9Kk!FVOJ`el1&)NIBj{oaA@6S7U0nhW?vDSC3d#%qM zsD9e2D$-hC+v7p6t-X4XI3n0Bez)wwHBqRWdS=S*OYQ`>E*tZ0P{ zGK7x~hI~$fh~>!0v6%2@`qu?Q*yr|(Atb@EZcFvUaa?MgBUjDu{5-3d>@C`Zi;sfu3zhw&n67hWGly z`E{H|otta2WVuSO05tvsPIYtSDP5~!;E4_@D7Y*+G`!52 zv(zq8px~O}UxV!O6i}GY-|?fBW;|bS-2W=>ZNkU#%UgG@{Zg4MF?@Zf^-+*5-7$wM zD;)`2(>nn+B0RscncqH#XHs|lF=D57cTNO^A#FO$$!5DPjfIk?Cr8e_#|`Q~@%Vi* z8fp?-W2B%#6&m>?CL3uhe=f_I6yc(4)$612RWrS>YF4NztAh=TO(^g7j>$D!UOx@M zLu(L0I3|&7ltS_-ytb-k2(_+e-@DmfJZqq^b1~QmNa~X7awTg&+AO3UJv4GUpH$(<``%v%kxe(eJ=%>m;wFsomHl6V(En)O zKPrIARpuPSuHIfae@oh>w+CW+Zf3-atLIG6WW#wZRZwfZ#N$!-23j5&bVbsUtJdu` z4QVwwD>ml6cz#tYX?ocvGF;P>*k;#1Xf-T?kC~wzN(*tb2{V#ToBDF5~LLy(y?!-4IGa z0$*bY5Qw(i_X;ff0#-k3VRWc)h4Y%!d8+l6HueyCp+~+H@_zlVwU%|Sy$zlMC+z~I z8lvhythUKMDF!5bj(4478QosG77lJ>>XmVsZgLc8*ehL=Svr=0F}Tv1p6kLJzL84j zW1&XRFVlDO-UVA`2mGEfW5uq{N}hJw_p`8lBU!-gXL1tF^%NXK@=xjip6PxAR{>e` z3fdqqefdJ;{MbNxG2qu+9&(t#)ZuTvMB09^bI?ir!ol&YD^2YlDmBhM_QJ^Rhcs%y zSHB)NBuH7aO`|@G*0Kr;o^L;#Ov%f$yXa6bar?Tz^^b@CdH3>ub1N{t8V%tnYBf=d zd(K9jmv9bM^c}v_BYhMQ_;<2Bjxg9 zp&>e{KM!|%#T!DI^2ylK5U-}m45)&xqOqFdf~5{v!1Q(XHFwa?^9_|{zpW0OLsq}5pU29p?G#&0<6}g zI`S_1zToA>qmEC8`qM&QC^EO>F?kUN!U4{3p#CY}c=3&Bx-r1XXtd27C>W>{-B|zg znNLl-qx$(!;lfcjug_tpz;J_zw;xEpP*YGAKB)91)C$ZO?h*T1(Zy11cDB)Ijb>tp!U=u>SFo+NIqLcVLzbS~V9yC0zdg6VEjI|d|7O4-_)*4ujG-`FNJ5Cdx zNfU)};e+Tr6As+!;hC3)OBa_m8`Sup&qU>XtA9NM+zl4N4F{gH58JBfU)kob^?=8C zNn=(v&)JzD#0Iz`63<#rkWcf%Tvf(uC3=R2lyc1f?EL>H6m~(sH-%N@D?}g(H{gn9 zjbaD=#JOu^;1)mXrW`r4G_J_O!?tBSf)6z3imt5&+oy`S{xx5zZ5g+k41YO;q9WR% zFg<+x z1IFaM+q=dM^WXk8P~6n_DzB^0UrD|p_}4pr`mc9v1K!aB(z@OMt`UB7GXisSgC*|{ z{58FVP@!>fbs{P1_To9|Y{GN7fHKh7m&dW#XsWFl{zZ$49|?`^i`o|W8MQv4B-YGqjtVa)I5b7~dfZ=Iv)He(glQFes(ugr-w=6!`pJE>n& z`(9Y$j;x)5Ia`cXaCc6eghJKB<=4sW{TUk2X`LvcgJ&R#vAQt+LWB7OOMLKkp!EC_ zSw>RNRZRjQ=E$6FUyg1If}=|on|u16<2MSFqDZ3%8kSw-%xtYqa)sgDhZ4;grivKB z)74&j-~2?@h^UH{h7{!jCIXLga67AOwskoel|6(8n&0L$AfY>ZfY(;g%xw4TRs__qKl>%`RgF7Vw)@qftVV1By$XD6tfxzh9% znFSKCP^QW(M1{S!@)REN`ob))+=ZEcOd$_yuBwVF=boD-h+|-y%X-N;JYf zl>IA!V^2sPNOPzBa1z(aBxOu@*8G&5sX8(PR_gg{x}K-k(kg#n>Hj6!2o=PFr`u(NiWjdW69C2^lXj~bVnLBSL!FoYiBz!emx7P+HqN#T zC&gi(MeGk4$@YKiwW^s+<`*r@HG+R{YlXY3$IpG(a1jLnYE8?NjnU# z-YOOe8m@YsMWoWa51gQoX%@Yc6v^d3DobmmRW>Ja6z)b`$owk`eySMrby=w)o8$LWlJr*_nT8C5ey`9%s8{ z`o)?&J{Qrom;8wshWeFr0UbSuN6`U{TN*d7pX0y1a;FN=*1o+F&kK>pwe9Ri|Fe(G z2n|%gYo@k+6xtT<6aNppbx#Oj8GSw1E;;s#1eVA(gZk3QTtWX-j3UDnmc7AeidNdh z2q;r#UZ#pwF!3`yi(yAaxWky? zo>kgzWc#1n)nfAS*%$6tUr)t#&<)@1ZL7d=BU`RGY)<;M=H6de#g6}$HTn5}2yS9) z(KtR_A%f&2F9WNZ>p<~?noanZ4VXGgianP^tIgJld9l3OyBokkFLY^4l@^<#@ROla z>bpcmq69WE9mr7vSeG6z7sIZg3v0=g1>w9v^h_cNHB{e{uFYwp4*Xd?3<&Zzk~h}N z5^yd-YmY=?&B&gYZ^t zuHVadO75tQT6siPLf-yUYZE3*8v=!esLs}>D7&5cs{)iR<}&VTUn!VzFbA*9vaSV` zmML9qotJ%i0K2`Fp9Ub6?6A<~3r)GB{xKd!2lGb`$g&%^KciBbnmGNm>=8U)K$USE zf#4kpW;mEey_sO^yq{!%$tr>I*^^&1w)mI_LToD+@JY@XIh_DDJ>#jES4DyJ^^=G1 zR(h}h=V;=83=1|T4_fJm7hd$iy1akQN&n%A|4TNs1G)3Z>(AXFXr+Xd|1!eB_6?@I zSENs7SpX0uam&9R2Bdb0@7+3P`8^0S!t@_8D-gWWM*J6VQvd%0ZxRKBeo0bOKs6z9 zu`J~U3*jQ?*Hd?K#(x&D|I7Wzq<`%5d+kXp38>Ak zo+!0{W>bKdSS19`THLV3bN(3y|NnCsfo=-5cXy%r`U^DzJR6iwE0uk80<4Ubl zY;E>g{hh+}ZsjwR{TG=s+D#?k?-+KgU0{13{@++hksWte z0v6rDAh!VYKe1j*sdQ2$i?kTH#0kZmP26jh;sM>tbG450##^jrttH3e(BdOhTFl14 z_*(Jt#gv{gJ;vdN*KU{FN3UJrU-r#=Qdr%@P}J-*c$F<^uGK4U-&JTLbGO}^FY~Tq z+MbUz(*qZ{Pmz>uPbjGt>LFpN+nal^yQF)Nqgl|AN$<%@bSd*Ar&e8V19I{A*{HcX zwP?vp5ShfWAWP9FOAiBC^QG%B-j$O&Sv0IOpyx($m!A++YS^N?lq#XO0UaQt%Jr>b zed%)|D&oDbb^(xYdZmiWbR}+uMT(W=xt!f&g~pGZBeKY7|?3G6Vsh#?V}K`a~CT`NZjA92;XjT@LvG#W&2(l`M%$T?4)! z*;_0I@QWUbzl~AUqH; z)vmU&VA4cY4=|Q;Q=VzllyMqZ?sb;#=GpnotqfiJ9Q7@(U>4YECUXMQ;6U&42D=() z7-j`Z_Pl^gw=@l$cKm7px@RoVFjBX4qrQ~Mr^a-0YE%|)Idzz&?I!!sej#$uC$Bc%eY%$Pv{nBD}Re}GB8*f0x@0&}by@9lbqZ2wj)iSolku7$) z$0Tu5cj5_dG|cb&AUiV|z4fT!4hUs))JJzt1iJDSkE)Nyp$3y_&42Gf6RAtea*G)mNx&A%$ zGDG=?`xzI8q0_7OjTfM>Lj})ZU69=!P_RYDg(|D|RE;Vr1xn}a#{*(|KSxO+-$=`@ z94<-Zy*YS)$Dl|RQ0EaQo}YwA;h0Okk;dX^D1dtq@5D5w-1dEAu_*{5?h|uhyzOIo z_mdp=Q~cR4E5|_moe#DQ(w_wNSsOrPxtb|ACE8im z*_I0jgpOk|aA$6rReOIxtthE@5g*9iX()!*7r5aS_99PvlzhgcSwnwyn(I{*zS?QQgi&FPwB)-_C%9mWGjJ0D*yD& zsS6S4Vl8ThAPDUR>jyQm`5izokPRA~RTk{>5Z~LD_05KB0$a_MKO64)$=>t3_xgVV18Xr z5wfKfDAJqiIn6wwNXWz>3nUDOfQOx7d*6j7$I0sZdvs&LrD{_>PQki7U0!QNHI;5B z1eLBUj4iqOafWX(n<0&{^-$%EM{eqe+^CHXDs^VA2(LG-&}U- zAvXQWF+TAcS8QXQ(1?AzDe(&K)Koz+6C*2GLD&IRACfP9?@~()>STH}D!pB;e%Dt@ zzMY@1v;7%!&;v9)=mq6khP@9F|9MNL*O0BM1UTLFjb{AVm@Wk8l%XQL)@D|tbC>fA zg;lb0X$oq3w8M`NXcF?MO%-sWg&2F6k)Q?O?F~JO5ij+sV=>6CH+J2^XblW?n%zU~ zA_5`T+v#CEcKanjb>f%P26HXTr2?~F#+ncA5Y`z0ajDStZ7uKXyg+#f?~lE;1yA>p zrItqJgWzDnw=TWQKz*%HQjSQv9iFICmno!N$C^(nKB77-+fCpvfWk|Dh9qTf^bml zHN**yn-zdnYTVzuP<7)+=(9dZ{Le8O4Mco z?T_wlO<$nD^Ac1ZIKDdo%-oR4PsCGOw!s0>1x|5rpmr& zpybQ1CgK&%=#E>Eh*qLmdU)A3P`uwmxaX9bG?XUlI8I@2a_F0>tiS7F-ZKi6q)$@3 zU)3G(LNYrs%}6NBV2Ot|RwyQpC{AH5lURoKC$cK`oO00F5r2@Az^uCmmsU-bdAhRz z#bWGQG&o6xcoKp|z8^*Pn{@G79LNT~FYn`9IE08+%5o^Zm5Ov#pcB~rvZ^kb8PxEu zJl7x5dNaR7e~A#Zd-CyiWT0W zjO^EpbTlBka@XOyqLw?WBVrb)L*)BDSN__!Er*r`1Up;{;BJcN=Z`X;TpTaI)qI?tc96 z+P0BZ%Ddx~ctN}jx?UdI8HWk2CN`(WbQqRh+D=i~t8 z1-Xf{e?uU_QXHsX0L9x53U#*m7VJWwv%k5y7qrT<_|!KM!*UYDG>zpS4)t5B_g5Cff-=rs9P8xx4dn^Weusar>nvaJqGUzeO{D5>y z=lj)hX8bp76Sr#MLx(J>{`BWypK7PiMdddPFSFHU-Os;(%ivC^W&>oAq2;O^O+WT~6;$-2;2(I7TmhCajaWeNt4T;j_(VkZKnA~Hm(-+v#s#S-A>cpLnU9)c&3Gz8cv@UHAZSNDw31U zbx=gg)w);Kyu^!mUiL0QrNSYJ>+B3;zcmI!ZznUM9s`}2m;2uPL25`)InQuf1FrZE zbIL(*=~Mf0>%arf6D{zQ7IYj^g!u7hRcnB7hp^envSXt95WscJHZ%GqseTcKp}IHP z?JlpZrTVKWUm~LB?rmdSVoZc@T8_}V3vd&Q?u|76O|4#_gVQ}t^Qrdy%#iDbs^gS! zX{bolrBFsK9Nnqz(TuTc#r(+y-AE(mor?BV41qx)&HAer0uTvz(%I!G*;lH+;p+aY z=PbgLAus$IxhfQf{(OJlRShFW%Ie#SVYi3Jq@#?C`Vfg;3$X}?z<-JrhnzvphwEc_)|R|f5#mf1U138m@r2zo`owb4kU4w z4&UKFmHufV7wXjNoqY~8g<+cHyGw^h3oMU@bbNZ=GXgvQJU%*KBxYjCPjRq1lKJ!L z*jhDM!xki??t!Gr@i6}4e)!44f~sprwkMo)omz4;iQAFYh}L_5m!rD>$Wxa)E^SG%t|{U8PH2oMh`AJj{l&S@Nxqrdd8OTC-ZGn~b83U8T!WwL#pPDY{)m|H|ETiA6wrYpbHZ|7|QZg0XOL8Pz{< zECQ;&ou$ZMc~>HQCV#?iFO9ZYhN1!Z@`NGP5A04E`;G+HMCFIXOL@hd$Tg7ntmhJN zKs$7%vCeDH_w#Mqx{`48%QpgIc`1$Gkk)9RXECC}f#Z)}o)D#c9ewao_v0dX(Jl1y znb{hwonzNR^8ttOO52l1=BV=ze059(zn)icOV93BcGZC3mgiBc`$Rz<5(J`@%5xjT z=}NZSj;_KVm(6PiihW3USp3(+^gQ=X*S=Exke+*8o>eW~>Xvsdqh)$9#@$5qe@Y)J&wTXP}nwy#hg`E_-gU@IU!~?1(N@O5&8)#BkJpDnLA!dk7MP5onDRUAC&*j*{sC z_f4=E*Jn9sSu!@IHy5cvxmBdaqVf@Mgt6)FNuuuECxJ7j)cKB1{e4a&?{{EN!Ig)> z9zR5Jcdc`XN=UzS`>ged+fcCg2z)YYnLnu1iwaPN#~^3XS%^7Cz2Q#3F>LA{flXu) z-&{)yt zcxV>l%{&G81RN%T-P_&>!Ti|yNX#R2xD2uZa_Ma@ z))ci5G=`tfiHG0f&5r{&OqAuAq+maK&KU$G@-)Mx=O0&dKW%c{C$$+B0lK9YH*fPW z+v@PislbaS^rwFi9HXy0zW~|#2Sh1~RP!}1NsHHw_I0WanGY2I?u}ma$~T37?x_Gk&!3$ zhH$8mvLUtZX-uFtIj+n7vJBr@_ZLTukxFBEt<*q7;$6YkW$QJP^^~YIhu{L2C_6`izNyX05 z1bvg;Dett9?<#Uie{MNV$OGB!jeGEb!(QQyjJ8F6ki{F1>XYI3SspTHRcU8W9u@bU zNo_wVU+|h`>LU`;R6blJUn-gj%|||bDJ4ztWllZ!@_iRG2Qd$ z7lfc(fNnO0Tv2Yp>iwFNe2TJaXOW)#viaxI3!k#~g2OZ2_zg9BoSO4vsJ;K*X4;9Y z0-2F*Wq%EMXZ5qFs<4S4X{LTB42D0f<^``zIs%|ObvYKXAU}t3zgIWy*p?X{J zTB71F&^+}q%WS*L(lys{K(z?~wj^O>k748zeUK@|90Rlyxo$I~hmJb5jq|LazJ3U( z`F-3kNs?mJ7)=&T%=te1B1q9M+j{-b{gV_jwBZndZHbI5@HzdWJNMwkq?|nfST0uC zauTS5OZ=)2#7Z9#+DcoINqpNpf&n}skB*G_uS1uZjxv7iXRS@@bMSqZrAjNRhV3W_ zGWy+=!4_<*ewJblG0;s0W5%_3a1|pfB%Z!Wc?k;5>U6pEJ@7gNny*|2TqQ=tlsIth zvqviUvF4?%>#Y2Z+rvrWLzjOneKu|)FGG1chKh!QA9M(NQSQ2a(IdadgUWY4vh_B0 z#D8C18;gY<>uA&8x0ul$v$$T*1P7D$4P$+Ro)cO~vU=B?fv-T2_qu4V&WiI2Bc_D!Bo?N3rzsM-1t+Sp zIA>kYajJPUUTgvE){~zNHD!F8h(GF5aqVsYY5bX_y+3feVtaiL;8YXv5f~;$c{_R% z1d+P@XoneP39OuWrS(M^>0AA6YqKBS#~Fq++%rB!-~Ts+^ChxPh4j>!S5#-##T&J? zC93b$D0REa=ZM4*;yG_45j~@yHSO5Cb$jonZAwMf5w=b?nYg@w#shMALdvU)=v+M= z4i>r%^4oamq@b~Ouw-Qt_sSMK1e^68;nO!VGH!%~=;*(7+9947ghKL-Brzf#Q%QXBJ`QvK?g`$F|QW7bHF zT7cV{2U%_laNWeDL3}(o8l|o;KYYFEyLc-=j>x>@-{A42J$DDYMxAaHS@*n=E5J=hit#iVz`oqNghPx5X!`8HzrcvNC z%pc`Tz<_2x()t--{CNdj@N4JD^IOsg2T{Mh&IVRx=*!W#a+mRQiL0rw@!u)@R)+a9 zBm^EW?pUvHyvT9C1f;ii;Il>J0>&@8Vr}q51->`ncw1WJ67& zZ=}oLZF*@F)=Ql4=h%|dd(0dnXQMJb-W~Qwl5MTg;ivqVvK$wu769K3`mvW(QjnOr zSsjKKL)C)1PjX{&w#ld3k6QLxPC>p2+#jH>0Re0m$%3A*2Lc8PR51)&RKx$ijPgru z27Pr1qmkP>SmW50(k~yM3^**b(S$oy;!TweRcthtHU&szaYry(1Q>jQgr-xV22E+^ z2^z9nQy3L{cKp<*M{X5HXZaqsWU#$2@LRWL2-fB5&&Vs@oQ?2(8-JSeKrc1>P{OB! zYk~;Vl8HJ&h4hMul9Uq^l=>d+7Pbc*H1>%>jB+idZ@c2_}ef$Cfrf z#~B1RBZ4J{Ld)!BO3N2vHvbK&GId8?Wg?%YaS7Z3Tr>Z*-Ogw%s#6DlRG739InlUk z{Dd22;p0@X>)z*@mK)zj9=EHvB;6ENd4u#*Kp_c7T+RFqr=L?N_t)J% zus_5}L=}H~MKGc?`WIfTGk$0_-*5}_357k|#RGnqIS%&p7oGZazk7ZTat=Ak3@D>D zHIrH2l{Fu!q8mQ%91gJl4G-TMkSVcP3oDZw;3G;R8Fg%$A~Ae2apk2WL4zNh)TQ$F zEYEfsVmU8CmDj+~xm7WQxmU31KQeZe_nIWJ?k03J59IRGU`Ghy&nEB!%Fyq&-K@a( zmQ$^YyM^Z{W=ib9ydRqpc-O|liDTDu9fFL)ZDhc+4B=2sl^cWy_2lK~n8Cm6zL!FQ-!m0<(a~I`ndX-o?Yh6C7-F7`F zF@csuy*h0LCDZyxE!KNu?%^tAnQP%t=f5}@clc&lzYX6knJqQY^x}V(whu3-H=u}E z72yb8lwyxbjKJz?v^GBcMBB)<0h{0r)?IS*mvBZHJw=f5nW}ZGioP?A_qIJWhgc%^ zSf1%#NDj<^XGLehNJR8itwM?mqf6uRIy}B=1SYJK>VV?}+aZ}aI*;l9xvgcyx*hgM zGTQo#KhPA`@<%1q7SfLTJ_jqLa58Fd9!oq5C@a}L zJ^46qk0W%H)*nI=LMd$PVGSFvn`5Puj0w;;MXH_FgTbey5wjN?Hvd_%YDP;w&}}m3 zCY98tUezQ=(eFY(bL!78Yd|Q5pmASa@fvp1larV6J=QxvpmhD{hFTry2HzFFoARg| zyWV3AWXx+{fP7T4nuEiv8_!53Sd6F>>PkAiZd;@WMzTPQfpcXJXW@&%4i}$=bdjCW zVZ3r(*(7KjVH`vrMxyS2T7Mo9f<=#Bzao2|AU#kW+I%`Y%l$k*&%n-{UwwQm&H2|i zYwNWc0{jBid9ewPeb!y_H@4v!ue^SbF%@)t)hE>#z_&*6K|76(RhvxnWZ7ZU-^Uv= zyQZD@N+uZn&{DbtgslHgmUMD)e0{}a^i0PKhy8J<*;(iu6|7mO>>yyzY@=2AqFn(6 z-FBX%Z{(P@trtRJCo(PcPee208f~w^NQFdBH2EitPMaMx)4k_K3Q24kw}ZY<94f#) zI_xPgD!0Pma?6{(b&p)aEFPgMJ&X*ZU|4LSR%j1eENN9kx$$VLe;bI!s1h`BrvxO6 zr;6^79%oBBkp!*K237Jfs>%&topjJ&I75=Mxd+OMImVnK{uVAW(fD2WDWB(W;LkfN zTjLJbiCKjzLzC-nrj6*4fq_Gn%+(7=kLKD5K|T)^2O?~4V|8oB3m@LLTM(|A5Z&I2 zaXbSh1`wRydUy2x{mCGZ(|v5q<5QaQles65w*G`THFuzq!xVfRI{6Aua*lX>H_UB3 zOH+(}1HNw(8r7O@l3@um)!$vw*B$YTf>&7hK+V8L+L>D|I`ey`1$3sZW!_JIC+78F zu0K{g8K2L*QLbFK(N%Fw)t%}tB8LP|F1AvC3By0Q^3NP~2)Gbz+BB+kxvtBZdbn~* zZd+FwsJ~EaMcvU?LO;4KH+N(kF(Of{+QUVh->vbSiDnualg|UG{^9s);TpM#)PsG1 zUsbrLewcBF?rbB!)H@^wun{|Pk?H@SeEA@FnTgxzadq|LZWqKfc|1|KXPwXM?@_(L zb6fkp8*-PU6|pL91DJDQV;5b9lzg88$OgRW6!Bp|8_q!w=z=~7UWI~RKqd3XT9k0kOhT*%cI zEp>|F`Xjow`fDSixfQ@V?p-Y?(lVeqIik@$$v`^m5`r$i6fP`E-t1IAQ&HTuc$1l-OSHa4B3XHWT-Te<7>H|`kai%HdXS*B&ABtBC2#Pn2 z;~xtxiA${6DZ##76XR6-rxHscz3Nf{U>HoaUaeC&y6UF3(F7I%&qC;&LjnqPwvU6c zt96a6*2<3#@xK`=Q6-xGI=7)+t9PIUK`F|m?Hvd~LkOnPL&tg&4};lTZXEJz$~u578o5307|>=dYkvWqP> z%+4#e8fD4uz=%LEEib=d-DKV3rGSgX8AcfFx`>~A8uQ$D5jQa6Z=;{S53OUyEU_h- z7_PnUGtfyk%AoNuI>UbHCfi=_BvNR?e56|tifW8*4dggtf(6R;_L?VI&Bbu$3?w>$ z5>IyghG?T+1kpYSw)n5*q8$H=bI_<}WQ!qaLS4u9tyC^PEbeZ{ zl(3329TN*z%(4pklI^`}0!hy~u&C>FS}0*0t*qWmZP@e*dRNwZ+kLDl{@nidF#0xi z(PgnF&aq>BFt}a`TF*F9P1)<-N@rH%aJk<^^^uL8O+Fn2nyX6bOO$8~7R515z~l>| zlHwY|wZ}An$zChf0hsN?f#}u>QP`DJvbd?8CGcXc{#*GkieOzbzk{=3`IAS1FOoPKs;tNu9~_?sUq^>xp;HhQ zWSpc9>X&4m=y|)f{@ez3;MB0!)tFbu{8_^ln$wY<5}tBRs~zPw?Pz7*mlW59fK@NJ z`exHj##u8H9It5nkw}KMPH>W(PWML@=~qpU@2HZ9YuusDqI6_1#LL3E?49<3j(spk z?SezjWSdiRP*Yvo^^winrs5Y*X54W^ zeO;7?75~i5qp}aj11<(#CSZu*6n#}?wOV5yZkV+u;QURnbKiEn0r7xN&3zD(BYyNi zvbnOkr~`%)tMUFFYJGPLNNQP)=mE@-q|Z*k8o}eLy87j1@{He&6E{V~ZAsNAQFuGK z{RIfmN;Dw}T&CEdMf!{r)K?+6_Z5O9&>omxDs&MmY-*7%P8X~ZdcfJ9s%&~L2tQLI z%AB>`f~%d9LQJDoBK1Z4Tj!WE9*dEN4|%SBaI?H}tbI4KqXxZP(qWYK(>P^c^64?1 z;ahS6P6KN3Kr^1lC&;tb3#qNoQn#&AXYAMO^j4m460dg!9?{qg-+K%?Za82IF^bpR zic6Ybzg#pbKqQh&LBhEls!bai%6&MWiP|!DB&~Fb9nV(nM9Wz~BxZ`=>g?@X*siZ^ zuBa)Q?cnXUo{tao{eFb61|1Ma8MMz9|23&D84}XIpCzoCiN(vJ?w|N*91%IZwA1|W z_^e`YpVUYz4TM@fdgnASB-9V?WmC+ko6*r7zCOB5joK;m36k3|wPaW_sM<_E_noTT z%0z-6l$AF=1sQCpFaQ1w@hlzmS&sNrx$^do{rTqA#x=VG6BSAhO8Kc zYwfYzvPb1A$KDNiCpesXXxk2lIp{jnd3B!Upz2zdWAqTAIOV)k;@%mpTc@fPpDdJh zd|d-a$|qgKzO)s&5SojYW-QM`Za7N#?-G3KB~Ea+|N-{ zZdo51HzMUV51OhG$`4JkO1d?VaQsr_%59-B*Y2p;Pu?FN)Yx;4&H!EIi zPANi1pn7%2E9FL0dXcZ7@}$^ORn;_T1^V-d-#NRzYC-DuVB|wg3sWAVRP_96hmX~0 z-EL%FgIxa7v|9FWntN-pgl>(4p|I%u1LF<3^aJoRm~Qm2NuP*AM129c#CaejX(&e& z?{$*NIF&@^<-kPWWO<~%(~ufex8CQonq{)I((((Q&00y_S*u}pefy}Xc?|uyVlZ1@GJrxr$a_9VwZ_>g{m0UEFQcrtZZcR`zm&UG(#u` zirjugeXDkqddA=TEiH*cHO=3l5)|&xD59Y&f{l2K`H%lhrUhKb2zVp@`;{&6Y%2$fw7)>IP&ftem0r z7z1vKt~1E{!vd}(Tgk;#Qf+61GDum9>AtlR(bNw6wbSCqBmU#`fMp%H)e#OcWz~2z zJ)GZ&>VsPgC_!B=~Cw`AbcqmU$#ZSwoU5X+g8K6l)BN3=rn^poE*pF9} z;z|yjY1y)0vC`IAG50YQe(>!W=ZxiH?uKLL1R4ra--v@AAxSTR2E9^KlFt2 zAh^rWG=~9`oV0f-Y(Y2GInAMRS(GCX^V0GcaIB3Px>u0yDMPNZ)Ii zFP~f65_(9F{w`-&_0=8T9&a^Mh|^Qe@aAQw5Y2X;i@jdM881r6tGqYO(@q|AqvR+z z6l}`di`x<&C9ULm{sTv=3a1ip`og$!2O?ONHIai}7XLccs%fU|dD7tS{u&3Ll+It~ z5nv+}RU>4RquG}knB>-mgKT`B<16-5=cp=EUmeBUZdRzkvh_~0cTdqcTI3zqInCf@ zYw&5m+%U`MMXm<>jLupnR;RiI}Zj^%P$-MTi;S)gj&Dl7E(`+3%X#(G<$GG z9an>Uu$^2fn!RcCRpU6Moyuzwvfwh|*!OsVE7hU;cD^B`;k@Pg^8<9um^KH7(L+0w zT>2(yo}SQY3i{3`)xhLWX(dC|5r#*hBD?Ffb|O11;PxYeW!&Yx!J5Y#Orz zOM`_X!4f$%4h#>QAD-eogOVv)E6{HD-G&Xt+%Yix*e{O6EKsDSbU1CYaw7`8_|##_ zvJS0OK-WxQN}bgY@pvGJzb5{rl%XN_MOMzZ3DXXltpz&`e;P4ag*xGM%Xbj*S*_Ua zaDUi!)WQk8uad@Kp1ROOT#P+6QG#9MZb;GGbwh&SgWz8e#Gd*u#J0a04(70#_ZGvA zvJIUO-23LkK^L*YPQb7DJchw_L4BK2?jL?L=l)Zbwj;<*M=u5a>LpS8{5m0=4u>wY zGLw2B4fo>KBzORr`O=9=12SzY@JI^*V;$CV62C9w$&erov-i^ ztp9Nln{Y9Yes7v|R5K8Jqmd1|84D6tqXSc_Nt*IyE@=Cyfyqr@qMqXPC2G4*{O3?y zZKG(~w6(%$%T@1Q4SQC1L((yn79nlw=;Idx}TNLBZ{N1-<+o_{v@dQ$b z-oKjm)G`8Y!;ZntXzdv+qTu^bD7;1X#&Yi3h#PdcaMsqj#aU`ipoK`_&)i7%b2`eP z4oEE(RJX=SGIl#yMciF_xv8D6L-FHZtv4^bG_9-HY^HRa4{jIJ2VGsk`|dDhG8rG~ zWExQ|o*e4_S!I{lHgd)c!Yi2UoL| zGzz&I#SCGUH~E1(2!xMVOX>ADfxm!W%69HrT8mla{=(GIOeKAXf3Ko{0xBB2dMR)t z{X@)HJg=J$gsz1w=^aYI{p%-kojJ;6%V?2tOx1L)hGzUqYp-a0qiU&h7ldXis%uOk zL+~B2wJ?y5IkWbEWpYiNy^f192k9(yx@oCe%>hS2C%XUxco z0mUMeJlqMx@Djw?beNLF+-1nDLov-8oMh^9;wgl2g}-N4QQbUw(>p=#TE~_NW*aR! z%=Vs3s)jOBdB3SGsbPPD=P$o|S^A-nfKy|g<1C|fj;=%cYOGv2XOM`aSjR?X9%CAZ z>#=M~Xj5PiM0t}wNM|6QK+E_Phi`U1dO?iK!Jfpa4ls;D&Mtpfa@@(_ck8NfraJ+x z(R_Peb^kZ|g65$ZCK2h@LyjL)nMR8`q%FW&G(E1Ympe>S->yLq?$Vu6Km3}EfJJta z>bcrVZ#)THO)*btM`1|Jgo98O-D#!;Z5ydN%p663gI4DVSj27ko3IWk7?~z))V;Gb z3@rXHFVJIIj&2xg5FL;zMM`d%L{m|lW^yLKcJf0*YN*-@Wtu45?<|B?%DPjx#Pecn z)Nj6_(rp8;h$Jj0a3@Cg4rmK-zILedtaIk8&Xz{Id&LwS_ZL!-oE}Kflb$4g-fJlr zQ!oQ-T!d)0+h!Eth6a=rhoqN?7kCBP7eMKIGTn52#niI$C|b7t2;}Allx+MOu zdMSbyya$fotZAxxUVX|kU>bI74NSx=AbFQhy+D%)&%D`$-+*7U7t{5(5|McL&f`6z z!NN!qqW+5LaRyF6TyO>j(Mq>~mW?$3ZXcFXUNH(E;hN5`=qzqcpBdEHFgbp(zGm{A zw?b}SQaBG;)3f{Q{IQ2N_*P!zQ&gio@~(6`YF(~1_9h||lWgZ`c}8?2g7PR$2b*he^xIvxik#j?Lp%(iO)~^WD7BN^@KSqoLM0qle5-xcA6qETMuW3 zZIjoXJB6+avRIuEu@X7$lp7F42B_&>74NOY4U}y&O=|n{lg6n?Ae(z$rj#bt zmwmaZx#DoFm&<7b(?%oZRSYKc^X@wd=F}1$?OmuCfR;2v`R3@J_v#WMPL34N>?-{H?pGHB*)> zKhFjiA~XU*5x2MftBn-STQkhYkk` z1bF3>$~}o$tC4~xRCB!V`qKZk--lN9PCoC`9C};dIx>i%V{TZK&F4FxU#7-iKl1f; z@%jBT=2Sgn{rjs%yDsPEmY5mOrt|M#)0gpm?T>WMe5IQM&+E;{;9eE0iX zq5DG;9|4Cp-*JGl&O3vW?_0E7SFX6dX2-TA@fIf2;-VMsHs4~m_EgBKD-S2=9hYA7 zeapVm7xgC(Y}j#1VQ_hKi`ofm%i zlZ9^f)T(d5s^gXU;k&!H^TvAsvqjpcq7&c4)Avl%k$4kRYoOzN>C>$^tI|nZcRz|w zth^#q{3ktv>uV!p?RujVtCt2#DXey0p1M(sdE?*taYrLRUd{6}GFh*h*8FwerXQ>B zO(@HAfgxqKR8u_-RQ=9DbRTyZL4!|UYpj#D@6bJguX z`}#(B;^md{wd(%%pJQ(AycV=Kk7e)NV+&suM=ks06;bpps^jyX&u8YIyOX^$Z{mmZ z?X%520_C!2E;U&r9`oSu%T4bauLy>op45LlU_O7DrCisS6+QbzUPb!KoiV*W=cH1% z&YUx*&*wOQeC73i#jU#YuU-bsUGgocwx#?~R;#N0hKfxNKlG{|Rt1(v+Z_4$e_oy0 zmgHi!?$%8S*4JP`Dt)_F|6^6VS?jPK67v z3Pc z05e?3>!gn0}?7MiReiD@*D;i+phNg?vmXa<7klF?EMTnmjB7w{ATsX|AK3%V2+4muZp)i>_H VAUMk*;UEJLc)I$ztaD0e0svNfxw!xU literal 255161 zcmeFZbyQSa9{@Tah=>S?prF8jgtT;*beD8VIdl!(Akr{2QUj7A-3=nrCEXyxfI~`4 zzr+2$d+#US_1;?Vy?@?%m$io3=j^lh+56YECqzj>68kpsZ4d~AEiEOc0s^5$fj}5v zZ`}m$BoSvifk3zC%tb|&q(w!+N)EQK%&km8AgPe}L<}WWB%$wMQ+_}I;Vp5Q@A6R! zAS8#czawsZ6xuzRJLDNg8iX2ljPHYAY7MF3q4%nM4%94V3~gfWqR1!=Lw{s(hzcuh zu$}kV8|d>HD2T3uH@CS+*W6?z3F5e#*}Z*C09w3EAzOMDvwH*ij-uFZlWf`c`v|?cYZ~oC$G# zj@Qxq?C{%dZvODH#%DZy9$U9?URwDbhoP9QJ*-fFQ5JGM{>Jx|VMqakm*MFc$ z3?Zcf%QbUZy8q6OvF9 z&G;-({N<{hpD2F#f@KaqWuuC4*;E4Bqg4oc?`GZc&~B5;#!~9!BU+)hI|^pY+@joQ zH}H+fv9iG^chUTC#XctPuF6U#@1)b~gYj~)vgHgmI(Cw*@FtvDM_LD3Nnb8sM0(w` zCCWOwXQ-Q0T2y%R2R~D6w}RZ{b6e13X_Smn#Yu)&DDU@Cb$Pq{W0zr5Kc3*ADhU&f ziagqHeaP_f=Hrj({2wt;$?sEuZ{9QHv=aeMX(IMs;xPnKJoP&$C8B#tvk`c1cPsMw zlhl9;JG|mg*tIuc8TjsBsqTF8cqoAz5by<;H#6cPI5(K%n{O#DGbJvjWM-5YCAzev zm=tOGEv=9^aE=suIaauxg(=?r20FIp_}^*?gUM*oimw-$RB^bZ+|D1eBfs1r{g6GJLy{XRJ0m2 zjd1!lwM7g2{#wpiMqL^k&=IEM=aC(`M(p_;Wd5*r=nl_Ms-GM`Z=ZR4-nihuAZ*4G z3ci%cz;nbLM{_|3eb?ujiHr=0N~f0AB#dnpwaJac*^7Fb&789OUWs;;E`OwCRsSm`S*gOX-mspLDY#ro&4PtU~TjTCmWKP$05?WIM;Y4@P_ z829Lii;F)I=V~Vkeco;wiUdlGoNrFUH(vYW_ zG&`*|V^Okm+@QNn z_loXIY(`hOnYxrJfJ?P#H=ioJzp&N{$1{3HeMc!L6*u=oCM8{&S%D@L|Wla z;aTAg;e*NU$<4{0{bR{h$y^*lX7aYLOfa)e2vZ~58Po|z`ymaBPNo#g$DjVp{x$8_9m98zpL zz{&iqgvG~7q~b?)SK0gWT5IV_6RlU;HZ_fgZ?t)IFbnC5igmKanZ}>5Z;q41V#dx< zhf!GIY$CMTh_i=dzg$=ps9Sabf0>apsP+~y(s?y~FF z?#8~6dyeb*_c5gP_x_#YUGEj+jkdk1^^tW;WXht)m!tUfwDiv<^V_dm8ZM146F|Dc zcEa|;9vRv%tzL?M9RX)$>}Morw7y*Z`lgkUJRqtx3Y+|B(%p)wAz9$z8gV`MzUM;@ z2Hrx74Xs+WTFOQ@VqQka=?-&PUW&p4dE0Q`Th5<5f@z{xqIsfeUg1K-2HvOc@b?H> zD8JBQ7jReD_xpat;?1&dMB1+Xd8NI&gSL~ZQ?1i07$=xHVq5NQOey!GMW#aLvohL{ zxciBfT;^u4zV`LAdBmi}hQ(|Tu%>hPj3cIaD=J>4Cui{ov8`&}CZ`fa2=_ctK+6kd zi|bLCOW^G~ShZPfUOxW8xpQ(1KU49xO@?TjYa7%g)}`F)vmcyFWqXPlyU{Q106}m{ zkCllawc+CPE^d0q`p5CdWUKA{e4GYO&1M%>=;~PN%-{`R>Z3=y-zgYfhYumr2fL4Vr z=Kh=xqRe9T=;!vEg_;s)-6p4l8YBIk_`EK$*L-Zt*3#G5O+kH-_!w+uWlsEL9r{B9%29 z9^PFg@wTT#bj@WMO6tJMBF8SQPWGzZ-M#E@43}mYmMVXloQj(qwddb=wXBeYo@377 zpDGZ;3;A>GE#}O7ke^1%+0Y?@+MgM3Kt=|gYX;1{9GMnpH}}{EY7A~Q*ddL+v_q|% ztszWq`n+ya=es-fh4c{`dc~Z&&}Q|^us!C3O{Puk3B3}oIlG3TS(d7$efjMah%NeT zy=#is=~^1ng?FoCzR8FASbx=P{=6AO3rAn5&xiZWY|8l4(l;79#UA*YVA09g?nJ#p z;()3iirxfVT*zazf7AO|XUo>W{dW2YJn?{dU;T(@KWzhNt!2k(B@CYUEwSx}cuT=W z^JaW|LHgy7Mf?IBFvc6|(S|y$m_X--Mp6 z&M&$dNE!6BXnR{<5FT!pG3Zd^Ln%{-ltDp^?2Oo7`vt8870@z_+0aZ^COrk{x+aBM zpSJpZD3u)&ommLTFjC= zRLAihz4JqjA{N^=vAcPzHPj3AC5DZ20v0TI2xC#b9am5rbkFihR4{|4+Sc1;Z z-)Bt-MQVj~<<7H{7l6GRYN{#yN?smB2efa2&`^j$=s*hv_z0pr`l~I0@)UIAkNc<~ zP>?wY?Z3|`0N+=Cfc^Z(nE!m=hzSH?0C(;IAJ+`jKc7a6%DC}o8{;d`2NF>gm6is+ zRgE1?O>LlNwvKP8&t!lbn08WHP!Nca>gt0ctwQ+&n19mzg{GsXyd1Bwtu>ROiLH?- zldHAe)jS}6S6-lLZR%(UcD1&$f%3WvQ2g-(FVMca%}fFQ;}J(o0SZldC9tTigDIGk z=^4{A3c=f8Fqq%L+e77G<7xq z`%N~`|85J|AoEoZGYiu*=D+3!hVozC>-zhZ z|1(tc@1ZO#oZSCA^nbdp4^@MjI*8g@121(H{2O8a9sIwY{~gHBe6{!gfyI9S{l{GZ z(t@}7ng7C?;B5(sgLD9qkIlstugDT0v#Y-w0Nz1Q|MLyBQ9hOZtT%^%K*AttF_9Op zC>wJaZ%1D|3S7j=mf3EiLsjus7RD3L!I~r}octK-8=OI*f`)ege!PWv;bg;P6b0dZ zG2W+5NAsam#nU}2eDkr7vlwUg~IymK%aGHD{e$4jqDIH45$c zKd2W`EO?*4Ve7y38zoUP;(h=jH(loAG3uQa>pv?e5HjgX1@iMq5p&r*G>r)7(9xL< z_c&)96qyh#NEj_}iG=7&yp_U18J<}1q{n)|bogRo&ZR1mL95(#g~jh02?~uj8mc%dgX+ps7$qt)L9=BU^eA z8v6K}hbc4jPiq#O!%`h&+Jg}%jqe8U#CFH#NifhWXV%K4oi#0YML#jpl1LKqb*#+A zjEdBL7I+;1GHAo>!qZJ2Fn06lPa~~mUbrQV{1VBW=2nUlUY>__i>zipqJj}H{#p60 zrq$x$VhGw zNaqg%dq)P8(3QS{Ga|NEJmBMYZBq1L^2AyVI^&)LXooXwV#7Tm<7%Ca5h~%*xt0dNoG2>)GhvneDBtAuT z1_N@-iQ-sBof;`WRP=1u9V3-yPq%#Kreu?zI9fZMM_kr1?JG>qyx*aG&fXs@=G8Rx znI@`tst<=1sYRO2-%$+6iSdRDoOI` zi{Y>w*Y2!@43g4nR|X@Lt7HghHHxjuQ-l&gNX>QEwvLG1iEl0Zru<9cm)+eo=~n%x zn>9qcorPNE?gtj@O#bfqxi|Bs-3Ppy1-U#;#4H=^OPUyX${{Y*di8S1`{^zN5)VbL zNky!5Dxr)PW2h{%SmgFaasqvPTB z6$O17^y0(bk`V;@NZE0sf&4AqVz%CRMtZJ=v+bO~d^gEbbS%Qqo8j9&Ki+LjSMjY~ zJYwfooSt`lO;DfesPe=9=eph?rT|wacD`08na^(iEYy}}u({PC>L zM{2&&?a2xa*An?ijCm^N<5|&deVELta}7_$nTY>QDMU{~^lA{yVcZ^OCd_8J;+V&r zL&E3WHFx9~M@B90T#~T-lVd`c3U;(f<>s&&SwCMg;uCx5GRv64X&qS~>C>778IN(9 zCtj^I8A9X}fX(UOw<_L^UWJn(7pzCkH@|!S+-sAg&v#Is2yyZo&l-pDzdno~s~I%* zQ{0*GP(e|#n6Ov!-QShX%F#KJ%p7+alq5@N*s@aey|0^Q)nEpLW)*7B^9T=@ z%%Xs`@uJP7BQsb~yBAWU(mS91asA3#L3TJ20+~BGV1=%b;U$u-1s)7H?QAy^Jxp+O ze*CQL%l^V>sqzmhpCTOtMh3Wv4P8-L!*^CKblbHn~IWg=r#jmwNgk5~Q4?MYsXZyt1^V-L9G z68$C(s?dfRgzFL2hr9h;3vQ8ZHg1baNul@`;MV!d3*U*}KBk8Kd)*fXd7pdbX~vx~ z`qO=O;%Dtw1rFB+j4!>t3NKt{Nu0=d9i{dM>_h|aLdPp4y^qa93aHlcwFsCpwNRV@n~oN;1A7c3>gwq}htUvt%lvE9Y_T!>N|3Zpg!y`zCI)J@W{xJ# zuf{SM57nFytX8buHsT=uI`z#Sgy!4BH0zVsXnIk)mPr|4fKZF03WoH)8?F(EK90*kMnABr5Dd)+dBj-nE!W-$iHHAn3n8P>%D#aJgN zvKuHdIOA6G6d`6+d$x zNJ{U$k{8(Xr{3RXZ<6a5V0gd*BMss>z;E`YeFM&8Wmjg5-e>JS4q^^Y7nb6t+Sfl8t4y$QT zT~RQQ7A2t(>3;i(9prAP1P?wkw$Yr-5exbrQ& zn#dysv-)>``V_I$^3g(&!Mk@tGdG`cpk}i$H&S|?9Kx!@YF90>9$A~m4vXk0dHq;V z*O%#EtSodb_%KHYk$SUJ=Bh&Dgj=o&;mhEQD5;}?>adciMRTidfN zhR%k!qVzotvvp@1lbpi&TsC7;rswJ0X(}`WLkZ}`X8q*TA9R57y&7h+T}qZu6&=Wq zC`O`dtL0`Y%_}^dN9~)IrpYQU!ZqRJC@~F@m{AlTf{3npQ#2XE$>>t5xo1x&^nGH3 z*A%qzo|U&u3#pT(|pl_wt$jIQ@-d~v=Z zTjC(D>J~ku=dq$CYZLyQmeW88F=?94_TvJfTvdhqr-c5rzILoh=5`!kMq2Xe4OTZy)%y=ScZG&yXU3LoxtyM2`zMF( zfZX8Ru*yAf1o62)|NJ)Q;FjtV;Q`=B$4Eq^cvO3=Gg{{?EHw%2o#BfVnW{VyPUhLe zF?T}7!{^MgvV+KW=k@vliKY<#=qS)EYKgQXoS2DGM}Gs3AQE!@kr7v-ImM<(^WXIn zqEf28ycYc79zqAawq!O)F?++$m|JZU5lk`BZRr(EQ=yvQQ{JU9)tEVHiOJ?t%M*7O zFt>cw;-f-|na3`?IDX((o#nOdxw~`fFf2{uwsJ}{@3~H*)$CdKqDUKXwA7{d%PTjg zDs&3a(XlQFRWCL-7g`MH;M!wCe5E+qIkJh}ZrF{Cbunv+-vQ@RWxcTC2^0CL*NLJ^ zqw8={k@vAvz2`9kji>*yaePmnbdF4(44mJMq9l^o; zcbxU+7}TOlIGF=lZ}zq4dMM{g60r*pzaF{ptTZ6I%s5{Se|%90$jSMZuH=i=bRUy% zII+tYOgIt&r1k!XIoV!xbwPkOJ~_+iU2+#Xd|zqnlj5-l-?42zSFow8YJ$KO&Z^9c zfq;f;bNbKMNa2}NPiwF2qA35H0`twVqeMVbJuc&ZkN&5>;5uGpaH&gldAJUD+X~5u z?5}FuR$fu5X3+9)W1Uls&1IxOZ9JOyl3h!KR(tG8M`CPxd`e80IanJ*O|OBjD%2rY zW>ERSFfQR?63Wa-rv|_qaPs;=?zX8o$7T&P>s%0p6Mx5Cu52HE4keoRN~`ZWJI2~jE9!JG?d@5XUJ%Dl$)CzbWB^g4B}8`5>)H13eQd}W+W%HsJ}*EzqYB`>3Q(rEgv zZH^hr@T!3)mCLLf%+`8)dAQ}l9~NE`v6aB=QrY{Wv{Ztu@LA{e{^2|q#qLxdXdFi- z5FN?SLnIjviW`u3P|*TnRk;%&YNXyNF_$^sL+)t?z%q)DJfhNDIIQQt9_+@237er( zGVa3#JhDsbmb5Bmt1?O6>Ys3ATrN2v2oj}p<&rXss5|e0krD^xrIK>BnMID@i1a-U zsD>h2Uk4iGUA{VbUe94+NqPh=ZeF{cuTvB0xPB4r;rxmVHe+VZkT!kNZ_^FKMG&&<=NnwYfZ^_t=g)f`OO|6zXTUNDFhe6U@G1E?u zm(ybuDyyt!s;y)Bw$^Z~;#1(p?!_$E+*NSYH0rzCQ5&zX^f|$B}z1@5F(y0%T{k!J5JEGKLRS&sq^d7KK&-Ck775gl#ZhgtR(0s)AK zX<~V1qK%8MHyq~OR(p(_PI_dSTh^u$g@k3KoAT62F!bCL065^NoVF34>{sj}A?Z3^ zeswsy+q+!t`vUF131|zf09IiKvg~w^zt<#YRfs_&IV3WOeGs~KTN%+APc z?xZz1chik*N9%jnxNPh5crKU5(P_!ZBruSRhY>~;;F~k1=;v0NAXSq1T$&$qml`;v zrS?v%M-X#-n^*r*X3;r8uU;63{fJAOL^Y8;&~0}aQ+teU`=j5D^5Ms;(^czNq3dzh zP0t3C?wHJjC;<=W!IONBGTQ|~t(UxO7pL1)>b>AijC{E%R&^iM{3_UTb?mfL>g>fg zt>Sm{-!6I6nRT;Ed5&aqzYn*%9(LDXGsTEh!TTsG9fgFE#MdMaaCr*`B!gVn{9~@u z2mr2kKr-gGX_eB`>*5_(7|ahOLl*O~Wc+`19R4}{UyB(6m!F;p``(AwXHZ_-8gME66iDSf*J8YX``^v|g~NX_ z_b*xg$$kIw+`j_lFKPS#V`(Xz%M+%4i4Xs#bnkb42J$P#1T<5T#8aHVVD*;>!DU5Z zGQ`q)qxAUqfnX~@5gHcY^}PP;@xKg>069Prnh-p<|C1H})=>W!uS3m_QoGfDJzRdJ z2&n-@SWWzn{~r`#7aE`l)yeN;{Qa6gTengGEk9`yu=|&W_M73Sm^lxeuI6(L#Fuw%`Q=LtS_(0brz&KMQ>Q3Bsu}Xj z`zz;fp{Qt2fKDZ^8_Ry|c$4K`u#M>^=69z9Y4kz&`&=BJAKCMBD)>6`$4z1UhS>m_ zmu)L)>IGR#%1^B$UQ{ZpJ4Q@sNv-}!@S=f zk0M0XsZJV~^oX=we{#wVO}Ek}M+mX#kf%kV3>*XsKgx0CK5|5Fe1a-nT-4C3YO?dobr_+&Y3z2_C7N|ByUFB39wTk0 zcGgsP8MnHExri9RjfEWW>=E{Se_-H}8~X_9X~0*Yrs}X>_V_oF@<#_E#z5r@H5+6g zD(~je1CkmHR7xF+&oEkRzih*ZK+Y`@(M;Brdlip)%6miOElswYy|&t8=qI{|SBEg< ze#G`C`2g8MIt;x$t0a|N@nPqwT3XhjQQ4u&s<^xENFA8|YyO!pYOu7?FpXlHhgqqvYz@} zCnvAN6X9u?`kl&R>z%>2O$@UwX+e5c=ZPRfpVFnOMf!u9Kz~xr&yt+ojo`#IBv5VB z6(s`WIkh8v_Pejmf|<=O+>^#v!)`wQT+q{}v5E{e`)%!ra}E%bGdA$i@J`vuQ~iO8 zzN^I;=Fi*Xz1pN`vQ~*4sGq)V{&fk5Zv@8A`DMi6duqjC+@opTMTQ#5YMVKxrc;~) z-4$oAl-`{ADTr2@sn9{6nTOiC{iLdwm=1YeP)YNJNVV16N?-lA;T3h7xq&+pzZp5; zSAMRjlylz$N}8i&;uT^Y5cFMVZqP!(NGCy*7`gyYDQVx)938Te-V^fGE}MqBh|v=R zC&;uwW@4_n)G{gQntRDu$U*(VqnyhO$XwWG8@1)6(e8taw^3I6h)5{77L%51CX)Y^v4%vx4J=kVM6EBwk@Y+Y%Rn21ldahH9RA{tXus@h>xwW;ckawIjVG;GehQ# z6TTvYZrT!4>r=34mZK>ri|!o86nEa;>cqX@D@@C#{UGj?Z=M{eByxcF{$2$6nFg>|(-WJV z18+qgZZ9zFk!?Z9Dh}SG#N3n~x_OB(t*N$VgusU$nAu9}O7-H(CexH#uJ zQNlsp-roS_VR|@=&I*}-PG9SAlwwk%S}w-o_OtcwKh<#J<^h&&>dVU_I5{e%fV$87 zk@m`!e5Gc&jOoR;AcP1$cOBo{79hE_TC6_LjqE$r(qQn@O_iHERdd+yvhz58FXd?Z zqIGBe4AdwfgZ)4}K!F??U2S~JF1Hjn#X7iE=#Ec5W z_L06g@kq+bcHv*QJ1QEe^f39BZNA&uX~0{-PD#vKnrFhon82>PHr!OQ>QEu8&7P1O z!E86~0&Coz=3`xg@eCBIKj4aaCC?Oxxp4M1$>)j{b*F|0+<7xk-D_8cry6Y2*)9`O zw0pIxEVxI)e>3cbHvq?^Os8(5?-|PQHrqvuTPJhngn*)J8b`xSl-Y?EI zf*-tI$=4lsSf(CyH1ELA4o?{%+Bb3=W)>)ctlC=NNVL#uU*ZFO?-8~Voy3M5Ib_W4 zRN{gbc}&xfKDH0NMb^V%KBY*Z4)&Pm8?eM=jt@Pw1U**~coR6%cgE*ft1MG|c_@fidvFNx zL|$@k>z!xau*$m6SWY2rYyx5e=@aY>+9GuqnijuJ!0;8`&i$KV^!X`3yiek6s~qvb z$C2G^NnEz1$b|;ru+7{F_OQ+r(uj|pDqtc?E7Ce@F_Ol?|=W-NkcOk1ntheJYZ}=|?rG3Di05ZQgs~c{#zhSw$xmBwJ6gxa{ z5$Q=_cz6W;^dkVDRai!z8#@-zFw_`0q;dYaw(t1spjuuJb4ALoQI{@)D0B_RgYgFMvos!NP#{zL(i4 z@f*tmjChaQZdM0OwIMb6>^D^b_*2gTi|^j2o_`qXw-2PR;=I>lp8P{Z?;ZuvhpWyR z`a1(#7A7uZ3D!J zlmsl8^HD0v-~EhRlwv?1d7;()e*l^gU}zxon0WpntO_Ov`Y;Vmv;G&q|Dk)~6F@r1 z2sw2}|D_oIehBlb?-uN)&V3h`gm{R0*Ke+6|4T_E$lf%Dy2nmr2Pt(L~*W#G_;ksw>-?R{_Kl_5+vXNN$F8c(q3|}XSlVJ8k5-H{{|{$^s@$BFnU^d-!)5z8xF8t zrz#)H>FwK5)9mkY4|a2(VNhXy4RMP#bS4)Lts~aDCjP)8SDflEpq~O5NF?T{lz2>r zvT4weqF=casSL=05N!d^WwPT=N7gt1rqYG+XPHmxNh-7{ct0qJ`DUNfk+736K-fq) z$ksDDo43Cj7F29$Rs*L{AgpQJBn9!LZGNIbR3788MpM>uiKRISvW=@_WtGCA&Rgi{ zuh67e(&!2UegTDv6mXJLqiUPaPP6&gIKuO=S4OMcCa-XzdO}*<@xX%XgAVyPj)6SPi#}SuKy!hs`a|mI78BMj>4*z_n;@cqPKQwt2Ufo zl5oA&*48~4a^BS8`DwcVQGujKlyLBwgw?gd?^@_*d7_w`H!^?F;-3PWwP5B8rZ>wp za~#wRJC@s|tb5bn?|q`yvm9&r=tbO!4B}v80WM|zz@y>BwQyCf5hVuhv6ROUUlLxh znXx*rwK8jId(t_)$MxM6GitV~SxnKf>V>Yp5p2CG?TKt$_LE22A0lk&ug3;$F@;?VFA6_b?F@;V(VJpUCUf$%kL84m^+{IT8iUHjeTJ2*|mA51a$@C@xiNoy5(9n zq^wj%%|3yF6e-RdVYdW^DTM2b%&FXt*V`{BB;;_cH8hAP=#WWd_ZxLzR0PPKL5m;) zX|9`oHytF}eQfbBlURHx752Eu8ihZks7r4xPKc*u&z0tHX>~_(31(&UyLpfdnmYWk zcT|bcmi7(YLj&jScir+8hG63WLMi)~Wpux2)2LQ7R!?8YiM`<3no5zb zw^of)N%*mY;V9Wj*-a^8C9}K%W_eAMDo6Y6%44k@`Stfb;|!aiMyqJufp2CaA%_H` z)r@~Q$Sfx1Z?os$p z>D&Q5+lZM<{;oQ()N@@gU7eK>qZ^e7{TMkUF(9 zG7-*X{V2`C3ANa8e#y4q;l!w1!$Pel{7&sLg9mG=B3SRO$`!DTFr%8`W!m-4j#jIr zC^1mpKSQ%Btm6fL{uaQWQ2UDC^#w(x67($)i(cl)GV*XN>y@p%HicsN`Z{$T|U>=+ana9w{lnCNL?B=3sGhtJl zA=K>FnlYC3_;L*>X;u=<=Q~9~mL)`-jn!jHy>78vdP~beCWL=?F)O0bZMsDXi1fz! z{JaQRQQ_VmGS;dvg*nyfZavnbN=FLw!jAJuENje_THP$Z*k_MYO|#_gH-=IPyMIab zz&GMPsvJ2?$xQV?lNvyNycXm0RRoJ-NV#{G3EEyPKEXS#_JJzC&7}WM_56Y0zNuKc z`1FU|J=3v5>rs!d6~TyU^F7tv7LrTcBAkrMTT!z`?z0H1q4kvD-W^^&=la_1Y{L7E zKlyr{ZTDWA_ZHo4nA>BI8h%M#R_;AJQtEZw7VfxaojK%eRC|# z0}fF{OIl~$e8F#4Y6~3RJe+@mEzajZzIf6aYcjA~wABu`pDT8rEpn;mYtd$*joCKq zr9281>5NuM%rKTiy5*S4F$wdU4K!7t4m6n+eRNKSmUw@xlk{B{eDd&GKF|&e*cvR(($9vM}ucDK+4Ou5K;G8J`oLF zYAEsv&!3BwWx7)6$INM?)>EQicBq|-rw5m=TOG!?|5)FxFOe0eZ+*$lzKqLE*MAmx z!I37`viIf9_+0aToU-YUV1MB1vpk_Ag%qW7ZrmMl0lK z0;>z?BP`>?-?msTkn>FJCoPi=dthZ}D6~`&OdKmSx$T{P-zQj2h<#3t=77@>v3ei6 zT1^Wb?=A`B)bfLS)cMTX@Vpwtx&1mV*G`Htq7YbhJrmch+MivLa{kQf4yf zJHLcZI-%5EyzAzupx+%5u(@lt(BXO8pr}rF_f%6FaHts8mE+YCQ439;?=Fx`xztLz zWubh(==Jx(ypp&egY&tTb#~+p+8mJ(LP7Xf@d=-UnHH1pLHc{W1GMz81;<<_g(}0D z;v3~J$DEJdS1jCY*UCR`DiF;+-$nGiVhmg5_Sb$`$Gj=Kxkm>;7YF?QtZ1+V4AVc| zu0!5@YxTVP?h_y9!SW8^aFEpX?8uLF;lR65goU$AMHmX<+(i45H5WgfaYj~bqZ;7p zD{#|@b-m(!8x7uBp_K>6Hsjisv*!y1N9oKExOP`kjtfqM+xNKOXEGX65rk3?#u&)k zw)khJ(mg1jnsLKXhSOzhx*}FMcP|zjQ2L+n)(Qf~>UvD8z$uP&b8Lk)Jhnnce@_v{ z+=A&n>W=8p8&BJ=M2~U4>*b7~$UMic3nIJFr6G}&yh**~E-jxpDtIOD_h(0;qe7l@ zB}w<0qeha7a%*r>i0vVKdVZj8L!)cH=tr8UV$|$`M77wnx=U;2Z+r@aCSlV#RFc)P zg>H%aAy#VHSb=Y42Z@t&ERhP|1b zMm=pXd}8fkT4??z3nn7kh%$U@B>(8?NL`K3!?8u(^?_GYSTA;N6NJ+*HDAsoJ703SDPa}BgWirC8+#>!*WA+& zY$!~_mL1@`JzQZ3By5FuZCv8{9C}K?Ks!xFyWsPk$@$9GYeAt#rNp z0p{>(s#D;R7Roz88u(H$;OqRcCG(lB8xA|h1{i^<)zS_yG^uXPYia7P+AA|{_`~*j zhurbY>D}4^|N0e`e3smJShbP^&JdG7w-0QGy#WYdy`HO?!?yP^lV0b-V}9tz#rOWF3(k@kJqTYOalx|GJ9Gbz=N<+ zYGcNx&%|yK^a@cO{|}fOJOQ;=#yjG@7euu+rQ9j|V1SC*v2a`0;Z=$27puH=*^w;$ z1k)0TkVS76jcvh|i&6p6g6%w(EChZDAWZ`>^4!793YsPdj}ScE3jy;)rRjB98A6Se z!n-0YA-}kJ;IBY*iswE>%Vm|;JiJnjx=(X6*~4+a(V{*3z>Q$}Q*t|OAe`0tGdt|q zX_5Nay!ED*wKk^t7v;>C3OrdxU|`y2@OdX5i_(YegiPfL<7q5w;C+rUbGJ;&aOjv$(kshEN1 za{aQW$%wxbFD%Ssrqf*?9bHPhLr6?cq;;B{(o{ z1rTxTd(mCO?b6O!FxL4&zQHu-xW?+7sjgJQ9_j295lrJF=#|5NW?>>Zta`I1%9EPk z@V5jQP}q1C1`Xxd*%_qIUajp?2(KE<2COAn#IT!bcfH;?;+6Z1)8*IgAJZ+V=D#|9 zS0PC-BjEU{DC;q&Ta53m2M>f8&$aKlq#L8lmlY4XUytB`eLwEt0ue@2gm{5VSHCC? z#yqt^zTQF0F+<(w$``*U=>Ai98Rtu^Rc4sTe?FuOXr*bB8vOzz5h6R;&ET04no}|L zf7n)JEC3(WcUAbC>4a9e*l`KAv(|Ii1xoM@mF`)ECZipGm1a#+TD{3x@(rOStkcdOh$8=vg8td^V+Rr`GJA9xpx^f>Tnn6x_@pNkclRHHwoo8^%wB?e z`x-v4F8_Vq{}W)E==yn`9`>$rtY;g&DUYF5%?-zDjs73L!FBL+Bmi&DH%aOfpH`m% zC23dr%5I>#A`U3_q0~aJ-wI|a>3$~~lzoDX&lwV5rK0-)QCF|MT>l|@yk?XM)Z^agT42DWV?I+$4iHns#d9@ zM(fv%21c2gA|3%W)%Cij9)c2b5j#59Tx1TXCQefti5d%9Ua-B2m)c9%u6jHS)o z1QvVT5l+lV6>_@8`j|gB&!K$T|Ma)z*4Z03Cj$pu7v@#9*0uZcf%M6gdt@3^hy9)1 z@$%_xa?a=fHcCn(x(UP3Nw;5(lol__sLk>r(N5WNq zlOxb8B>G4`o{Fkf(d3dUg^IvL|5;p-?c^nwUw!ueOxACWZ8A z*c0)0`780dsua~k1bx=p{=1&Pt~G=6_7bIZ_CDfHuKpqCwWv_@)Fu%xCY&2Ue`lhu zzo1%Cl*Zt;*kTsVBz%F5`UWMTe1k_IlhVN}nS#?*gl_+nrRFw&=Y5kKbQ%R|+KvQ^ zR9EPB$38S`nP^b0IR02eVO$^ultR~z|57{%d=wrkbloZRZ7u8`^`HFo(+B&odz9{7 z%KuM~u@z=j7OF(wkF#C<=PH$+yEu~kYiUM&mct&>?RJ#7!D{r(C|S58?WYDM#0MIw z4_jp(4u8Ja;WO}}xuSGnYr|qJf1Qm?Ds6BhQV^#SaGM8sfu;>RpbMqTZ8 zgAOSV+F5|BY&BY>eWXv5(!}9t_09Ux6AsxIvi_3=&KZfGdSPDG9^lZI++c;*b-&$S z*KLZxS=SsZVI_}?)qmnpIUEKt@1beJX?frbOS8Z>JD7riUT2wy(A{J7)MrzOcFV~Y z*=_j?bRD%NRy{Xk4k~A+9+e{M4qLRnN)@r-#c4(++l;I~Vlj8GSsTb1A|LUTlC#Au zY)3N%5t=cViBwfe1@A8wy@%YW)+ zr=iIz^%|69ZhYO3j?3<1P?E8+UqGTWw|f7XM5DSdwf|q-GG3YE#lPNnJ9W z*5c^+Y>)XMQeY?>LN~nF|5(H2kj-uB=$RdeLv4T%7jzyU45}t~z0Gi5>KvI=GAa+A z7bww&HJIm-9z*h+;+^=u8I)?JQJn415-ni03zH~EOGQ>U7Kh2c1#|jI; z`%@)#m=1a0WwG6CL+BOHADo(Cu%L1~-8^Q^BJ)b3x~4{5Cfz;`reSBRSM<3-Fny!020 z7iAeK5>7Kf;(c=;T;B~MALo#ClQl{h4SI*6+@nI?9h3xSRM(21`L2yNW)Pe@jmg(5d<=BNry}9M3*0BejCRYrQ9dkL4aUo7* zU!VCvP$u>_loZ4ObHtZS#6i(nu+C=}=_Y9Oud^Ng9iJE{L3PpKh^4 z01+*pQ7YYk(Ty-@ar_~mZZhoWKZQQLKNHpBO2+BcngHH}wG;pp5awW?UKSs0i^RDn zl*Sjw=cl_q{bB3-Zi$Oh~Ckci5#ao*i}gT?gH^bz!CWJ&yGZltokbZ(M63qOI7)NihFVBu28j zzp9_pWlXo$E7Et=iV`OF(CE!Cu>;Poa_ty4U+|%KaKZX+CPZ=MKq55>EE~WIlqwci#7; zxsWc>g>S)$ic7h(<5zXVKC+kxz)kirzh@MTn}mU83$yJ(aY0J!nzNI~q>k*@0w83) zR6eLx?s$0f>!BX{C6Zm?v5-{rO@ATyYWKBQ$111nZs0fJnJ1FOcs3p%@Go~BCYxj^1L+#Nc$#2|VH)HI%x^@v6kF@FtxhM0kMiEg-hJVgo|HG^O|QbV&It6R?z z4E=u}N)(@6oOls>6n#Z>N5q+9ue}d1nAaliKNVcJoo~@z18Feie(MQ%)8tl6+Rz5> zF}M?-d93}kgs~VAsU{G?YE#hQxv(Gv-bNEBxS7v&hC5iVHxWDnRaGAMJ$F0b>AM){ zl!c!W;qV4Xdyx>1FO;(Fg>tG=$OIi|to&G4ZL`QCib94D=zg;0$Z#C|{brloi7M*j z^s~Kld!K1!pMY`Rky7|@)uD=hgU(ksoB(+1Nf&0J&Y)F}n^qaADku3C2gm(cEf4F- zE0sg8?W70j+Od;B{HAbN%cBY1r$hN*pBZR(hphe#?z|@8)l-Y51w>PSb8(*t-0oF1 zaK}ioJ^ooZ?W@X{wMKn6*XAtF`B;wLk*+dw4}93CwYX(5u~?8VjG5^G_NIY}-yYll zbT6Iy?5d%}LjR~KgK@ylVn_<9Q!nKt@A#-1@aEWeOs1`MnOyIbC+O&m zfrpIlnFUqp?mmRmszq7{AjeT|VnSc>84Ak_wY>7Bp6On2h1%vjb6P`>ggR0YT-={P zL^GVrkGytiyRp>kfv#1rAU~upfl)L2oe_+nkok?kb0XT1-4R4JbAOkC^5j8pFu-0P@aBlF z&3D)Zd}HQ%>G+G|9F5O^h_r>n7T{yLFW0n2a@vJO{dO8?uq{5hA$kr@-KSd?cYVgz z@!|dQz4JQn2+|}Ezx)kyWlM-ChH`TOW^e`&ZZgICp{-MNpyxV({E!~@#gC-*J-lQZ z(Bi6(33M|~^8QKu@nFdnf11NI5cchq*HSn=)j$h4PS2Po zZo1O1h=iHry>=ziq^r4)BF7)W{~Eb=i_KiuqNc41(s6kpu74gJL%cY)lu!EUwD3C^ zrIO!59pKt4ILeSQB;sH@T5z~C)kmH&cFC-%_BzNK%Jv>RBvktWQjx=y*u6shj8>o_ zTDoBE^Y{T6YXRKyzx?&D2}3eXWmj=o#afjm`d)iA)7jkR~6v& z;9qHTn(xSL#>1^a$Z;=aY;m=*_gL!3dA6~=A`|d%T%bp`S5!&ODno*J!VLCC&=@y1 zHnTMAw^){hM$gx8N-9r|=SxxNM|tH>ysQG~dGTjQS?G8y(M4?)K@6jdz{<8$YI^F^|>#?MCao&)F1P`Bx~}QDiAw|(KCs|0`SlNkmj3J zb{jofpzU)XEKPt)>LHkVDQT^nPhJCKvy@5DDM8 zl^Dnw8@w!mY6Q}0hQ2jqC*S>(UAsf`$AUe{b?|N@6APcHo{ekzdylym=DA|Ps@pWN zA&_RU9HHlKkZd3be=nZi+r)8`MTtQ7AqdeP(jVm7h*z)AV?Vl$PV3A^%^xz$%9Bm7EX=odk)VV`Q3zPO?Zhekrr?-LOpw>~@fQ+Eem8w$9=1x@&F? z8Ujrq#KV@f_2cW$PNz@^N&u8I(U9^3ZN}fBzqMl-=kTS*;<3+|u98T6BaADE12oCS z;@kgw|IFV#FN^|nl;T-55B)isgvBq6L9chv5bxsG;DuGd*W|pe!*gk0e$Km>^H8N! zec>)k@5}c3UR4Q|u9c?g{h0VvG}33p$<%AKed9yA?$h_tw941@F7Q-IsqPR6g7&2Zi zy*)S3`5{yLS@X*vgATgz>jCLUbzCc>!cVZ1ZPut0hw@i8HDRT@x{3!~Cle8aIJp!R zVJbCf1lo9?r*b#QF5!5mqd)L;ptrCeXV;tKX`H)PDVLlrrGHC`{rrv)dy?{!KjTFo z*s~+*37W^>LF4BPo;<%4z6y&s;_TGUXH?B6~yg? zDxj3jqghTM4{v=tj!R+*6AO@fu$L#+NA&vAh$vn6ky^UJ;C6`7b3vO$W7|lJ-nkNN z+eK}r1vrd0$6@VL#P)Lru6>A+78t!Kz(9{IndN#%vVKvfE$H1O8Y|QPS4H0anZN?- z#9q2Cm7bsiR5j*>abIrkGI2r_`!Lsi$I@0pQ1U}bfrsnmlHS_^*jrY(5a20HQ60njEaX^zwEJ zP6KJ=$tzB_T4?Di0@8o{Md6MT)mHjF2K77JA;>VDS?sT%ap~nCBw6a-F1ylhM=2;S z2MY<&gvUFM-a%6~VKrm`*wr6k_cnlXWGwJ&JLFVW^nCgH**WU#p^A_zFS|n5{HkDk zfzOy`=bs(|-cGDgt#5yA(=JrlPKtOB@jPR=Lsmk-a&;Nc7PxA+{g!1}rim9>Dgsd+If@bK5cXZ}#y2eO z*S-(C1is$ScDc*Ll%si)#@twzN$0AePQaxnhiLaPQqUZC+FTB>c-OJ3>}a_}J6wh( z{FOqE#X3siTyySPcmXj)_OkrPV5<8rZFvX3FV=UR%nqEs>-3QuIcuQECKa*wiMk!V zuo@>bOIqntw~{=Ngw(-`$3^psWnQpd%6~i=AV2_fHPF ziyZ;vil3=F49zK|Kw+jm;Yl)OY!MUSU(M>A^l2%rhTTSpp!LE1uBf#a1z!h7JNTJg zeB!8`1jia5YTbs5Ug0lv;WKH;cInWbEpzE|B5;zwT{7T&BhO;9eEp|AY5@?~znS6L zW6@)$&Z*8dr^fIW|M@AklE6rp@lgmIYOS^bw&Mv?qT0kUWsG1;2ikssUkG#CLfyyq>aXt7)A(z``Q*3R&wgz}cDXqA*Kh&v}b$DVS>{ zf3(uyGFt}IsVd6!lWrGVMju?4L0khEnjMHjNsP6ZPB6LtnVmC73Mm6Us!3cw&l-*w zd7kQWwyT}IW1e@*6Krx?p&}DkUPWTzSD@{}0P~mW&^#$>ebq>p%Ze0L9oSaDtD=4k(ZRH21J0ty#ga=P1^aN z>7ZG=k9MAaz+G)s3TN6eHc}<_1UFSXP1GK<#Yuk~eN`4zoI#)CaJ$l0E!pAndv+44 z)gx`%;-up=^GQgm2sh3=E`;wpV5S;i6mN8DxI#&0Xlr?s>^95^0i)L?bv8#b&1|v}*xpUE7!F#%nrkrr zJZmQa>_5PgMV@WmiP9U?;gs7$-T~A;o1tS)SgU3kE!rGRRzZS%pEPLpI4|n@g4@b+ z?~Mdz*fKKnI;t*wF3kjF3+~=&1t8t%u)}3ny8zEH=IbarexaSZUrS4xt=*wa*W&$r z#v9TlnWA|}437rAswIqLE*SPbrOjjI@Y|qMWxFK=o94-SgY@Y_U8*Qp4fnJXH9@oaeCd=W@*)`J0#Dn?n-<|N)!nkG;?$>4yX=`fzDreD1M3Ym71C(wp zoR@Cyxh(EH)jw)@{*M|mwXO}6l36UrBUfv@>}U_AkcpSV24c7yGvXwvIknPXD>cbT(k+K}J z&v20k#hYRjUqpn2)HA?Qj$t)B?&+54kuAL9j%_(r*o%@&pXkLaPPMn+40sYJs#X~} znRGObVndIH7Va7{hM79&@i%?|bcYrdq_ZUo46Pp*u9771)Dz^Lpp7U9CIdYGnmBD1 zq{XWvPKMCQcHo*)^gI2;D~tAm6u#)T9^#d$gY-?-3xaCy-pK=#4CSug+xk9qmwT!O zRFR8&gq2MSzpPr^W~`urgpcgb?C5P@jog5$5KlNuH0Fh0bP*4d22~NLrPYufb}YtV zUb@!gsgdZ1x65L@%Ua*tWA3h_#wP+j98Mrw)%;0JXGoo_7W1;uBit(@M`L_Q7nb`FjvaPM~2A*$0($*q)U+7Uk5XxuY{ zpW|M4DCt~$q;R1~Tzx0<+y(A)@APk$IZ_P-46f1f4ru&U9k$!g{!uU?!iz1M2yU$)xGyN?KQ$!23B!!(rX19q8MMJgSyB?uUoaPJii=v&9;@AJ|Z)V6-LupcNpKJO?dOcDZ-ivO#$=#g$Hstro zvx_`h@H02|tHv{onez?rmB`}DsMAv$7PIR#6UXP72>S!ygPV4PMsU;jk~Es@JS;%4^bP}?;~8Hj`+Gaf!ye9+f*@Xld#AHrhFMCap(INF*l8Hd+;x-w0%j)J%F+DW4Z;%aFr1 zV!Ivm@P%v_fH5KaNqFemJ4Q|eO@-+q zwIu(C!6r+Pg8}S45o6B1boTGXb6ZE_>ldT|qwmQYzh6xAl4^pu;=&T|6B}}B{gdu< z<8r(&#=1_t)z;N8Ml}^bzXp;U{AZ(U&evWGn1RQsb)3Z#kI^%&2J}*}*|e6=mGtcm zQ+ir4nB{}6;Y$;~jRR#l{QMPM`7#5*k(|n64AJOgXwh=%L83>=U3s8$d%<|qg2p_n z&n=582k)P5Zr!1480eVx=cN)Y!8F6^iFm|1ohs>31_-+(#2D46o!ik9@1-9b`Z5|D zcj)T{1DTi+TW-**W?t0Gy)nAx!|PED>S!sk8M-y@u0kfIDJfRC5MC~t(Fmp4qx|mE z-AGXPsJ&w$M9lAW18W@XX01_+h`|O7(No*Qc6)#GJ{j z&l$;>6B#1&_*P0vFBZSAJpeJeLN#Dl@D-mkV=7^nv+!+WB-4g|z^^|sm4c$%?Cvwk zp2_i=PEMa6XueCV3^DnPqz=hBQeYQ5kqsh4#d}mjI2o3W*+8=Vmoj6hHUNixmsLq) zlH{Pl+IS!q*;t^W$LLh=Q=cR5tpx}!%J_pY*mzHr{>H-PS6)_!u7RD02nCHCgk0M& zBp2hwnCX2EzuEa6+foys4f6RNuqyv)1N)NUa4g>-K*-J5cj7TJzO%@y2NYtS8LrKF z@iFvfmBTb)zTDo1W|tiQGw9i|Hv9dQTK`qQ1>#-jkl6HRwl`xQJi+R8`;=Xx8ko{c zGfIk#g>fT~O;;JO4jPP5>X3!Uw*|0rFur~gbe4IDz!{R)ZzA*&tCs{Uoja7 zCv#rryR$Fm2h)UHEShh*3msKMGpb7rl^rG?L4(fhmdJZ_hidHKOVU4>p?+|h1lQj$ z0b{&+3|3vhr@l|FD6u(VNuNH5uv@5OP&|a?{{3-T?f&ZtiI?jc{xRgI`42Ag_#Cw7 zAf$YaeK~J9gq~TLN*F}E*O3{T`ZhhRap0Y}zWoto8)l+?ier(DnHsED`7k<=(i+E? zLH?XJ>7gpa=aNUgSfM1Cgo^OOFxcJm1?C`MuqR5KAdK`%M&d0;?=DsSnbDHs#gZAaUQqNtBH0p4QZ4J z{8+!1_x2_q$x+-XRi@3sqcm}JXzCKt;)Hm5%~Bx@$!@jRjs0xzcj{Eh)&G}P{*}Ir zXBT+1zE#;hOO-_DAz5{0kY1zlhIcQ0@>8}ykZ_AT@aeAbBC8~W@vD=sL8HuVONZ6BZMIET#@ljo~22L zZhI5>p10;z{MEJxal6IKMk71k8=0a8CD;brfCt7Hn)mdPMw? zHjz)o{YHUv}2k1EO*S8m@a$CyuJIKX?VCQhT}}F&8=i&T8$bS=23YNv|TT^KO>7 ztMid58f5el2Xm_V0~?cp6c5GDC_*2}b&Rub95r#81+xI{mQN>txOaT}fk~=f4Dj)q zyg~CEO%ltiB$ixJ9qh#pj;t^G63iIV86vKJ8l<JPL+c1ATb2#dXIts>_T6z9(w1X>?yo9w+ZdRD+ znBVH?d98Cq6*OKv)0ay}ihTk((5}Qdxpm$oI##UG{;1AhXcm>a+Pi+km#G;U&$TiE zQ5n3^atY$y7Gi!{xsN3V_04s%oSSlo6wH?_OS`5t*43x+qRZ@ZOfH% z{{RbGKJNXCJnPGJ zuiIz%?gXW8HCd@}L~E{Ba#qAQ{*OL379VecZN$S0w!dUVT?2R{Uxn(TCMr`ZHkQ{-E()c7U9OQ*QyfIGKJX(9|BXCeDpu@vF$O_haGbQQi@4Cw=XmH= ztI8J5#|RUrD(}pE7p8YQS0(jKuyzeOyn67Sp;cAiu|23x5 zYe#%%ud4uGu|)3PkF%EqxD1`y4YH(7Y9IHgZoZKI5d%-fXqI`YXC7klS(w;JZ$DY$ zlSWg54Y6lD(B&eJ%?c8IJhOX8>$t}0V1(sBqG>Doo&4jFSNrh$)qexj3{N^$Fv$Vo zUb_Ol7|hAGQp44Bc5?3$sc{{48AXX)w5p_?Y^$lB=zL28JYIneStV`yZss~DzaXZg z9)4;j_e4(QdM_-GS3&mVgowVSyF65C^^fub_H4v#wqG`SrMbkegj)TYZLLR^fMB03iokxHIK3sS+5uKA-Wr(Kh3=_ePzJ5z1hTy^a6nT&?&>B;doAVH z1j=N3@)7`l3Rl&14{&Qewzc&^tFpV1R8Sh7klsMub~{bNk!fYv z`UlmSr&Gs~uue=)iFFo&drr{DMBzX;S!%?|?OGf}07Ka?f>U6`;G)8zw<1$bk(YBdj;gx4{_)Ps`Is<;#Dwuva885WsKs;MhrdQBp%ttlowV%(%FAZI+YMr=$8lMRQ~QI&yB zG;TQ;qr`xR+8fn8X_PZMJAHoeX5Mi~n)3@|ZB4MixHB{MCe{m}3qy=%@X(UdGbYf%{CX+b3sfyn-jEx^OK;hybQdr2p&N z;DMZe#=k>7w=Vy?ikk_+Y2Ic#>nu*nahYb2%#Z2oWQrEG0ScbQeh!X1S8&I4Glvdg-EC~Sm=+Kg+zPYUsDR2Ssc^P{gP{~0{W5}Ub5R6tVa%$1d*7NH zB7QJ9-ZbQTyA***4ceLJjZRrsm`%FC(?#dnehg(@(%uUe;(b`-5IMd;_-Z}A_qQV* zA7~E1JP$_zEI>r9HPE`um@71OJ3%#l>Njl{yAqY!msuO*#e`+)jl9}p$!g$_FQ)oe zc_;~qe>`b`3k85J2$Ie6)+|f8M0k#VPX3UX9J&IYX9+y#XkpI?Tz^^~v;%b6-aRNE z2{H``e$%Dt*1A*z(agQMCx1u5K<$}>zWKJlhT;Si7oOhPw)Sr8f|Xy5oE7h@pJ!m} z80LiJ_zOw_T{7c3ghb8tT>CsTzBjzZY6w)TRNDQs7I&B??**Qz0!bHDrJkc}l>^_G zmq}t4RWyl%lVaXopMjM+>oY;N8=D8k=<&Z7PqLSDm~d0BPe{DL zL(D>1DVFb|gCJve+||zi!2GZ8HS)JF@E{QdWBKW>gMo{#^iN-p1O}|Z-;MYGxG8Bg z!hT}xhjprRdW=t>sl~88%g-ne9^!KYbODV6uyYnIOCU_)=?whQNvsACt{>ndU#gQF zzx|*UTf}gg+%v(o!a|X&zd=%HQScNlU~=?i%@%twG$B&UIDEFOzvoZ!dDWps2TT5F zv%^yZSU<;Q(IdNue-wo|;pH>}6Z}S2U4+kf{`hl8e~no~MC(?kX{sChq{wb`3Zt*N zw;6E0O*2zq0Mm9qMIfG<$X3Z<-rR9(Bx~-}aChX=w39vlXsaZsR^tntmN~&YG2}%T zp<88z@N3Yx)MTH}yjcm5bDG4%EztEU_;mb{*f8m_yyf@apXbZNs`KPB#l`!`eU!lJ zX;ZN{c&G-=)#yx3m~aS>v#lPje6eH|t??&CKyiA;+VvO?zwXp%0Pl^Jq1ygTBslL@ zpN^iU=tbdMvQgV=6x3!&v$28L8~J@{G9=@H%bWE zzp53mW7QQgr4ZAMtorC3)1|}sHV0Sltj^0V;1=~OUT)ucM`C3VuFolK)`FaHcItZW z6v#qA;n3|!2@vG~TB1*#xNV#z$>Vls5zJCM0X3(0kv$FV+JP$Vo-K|;b@no9De+9x z4pERAUBD7(vzBbh6PCe)K6+8h0MZ6M>QJ$$_sKpI1_1INZ=RN=Y zh*Ps1UEZcdiKv!|F>?;vz*a}rD2`%bzG0nRt@VnVg+3`l9z5j+?72XA3t;HwynAWp z!I($DkLMg0flwP~IT|S;F9pq_2!o2pQ_36tZZY#scLQR!R49*+Wm(NP zIoPB&ky!+rn7v?=3P)#J&F@QdOH)sBw+MAiC0xS&bCv`6r}-YMFA57j;mot-hJB!P z^zG)+fk`wJSVeVtQj7Yss?TA!r{VRo+f;qK329O9lS@F8_?|V|E7a!EF=PFWwy)6k z)@itRwZzWjZ{X33=l^2hGYiAmY)lA9ruBAJw=VSV4w~TKz3WMrcpWv=rnFz0>yN+4 zu403Z&94sm9FlKDAG3dcim>(S?|kDwspvnrj+^r1P3JEw=G#+;T&1PIs9RMSLCj&F}vC1(?8r>QRW?4S)XY5@CR}J$3;eWxtHh2|LnVzl+|gQIsUr=Kt6@X zk{mUe-cB@H11!H^K zV&}@mhfAS3bF~XfVjLQ&|G?w_TCAcEqoQKPC_%aU?jz)N-G}sAPdP?kG8wtAewvn` z*=bZ!vw9F7Fw;aFE7ZxFan9d0E#Yp?bPT}7?cPih;NB8yMP~UABO%bPA0tvi3ih>m z#`S1QgWe{wx<$t|V#-jeL&r<;g0GB+uZQbReKv0Yi<}<0UFPNmqWyqh=c5YDI4GbJ9Y@y!AugqW^!DjnC()T>RruE3!%Na=owu-%bD_H(LeWs1j9 zCl1~#AMyn%Q>lARsdoy2s7o+W_U?y1k%Xa~&NT-r(|0*CHWr->ALeffa-tltpKWn5Jsa^T7 z!ddRh2#J=sh?*8ZDo!u1nU!JkTsjNUp@rO<_`A;hKMIk;7aIC9U?chR|EkCTYDxvA zp_jhlqVNN{|1|nQ=Nwh}!LY!Me;nff{@Wj2d&x|7p{SzW?B%WhIGRhDcs;}5uYZyE zf6Y)vY1W}?=+ja5@IQ{qQ6?S~D}Da=VgK*5)c-C{*YLvigogTGkE4S(DHF?issEb+|FZ@|N@ub13Rjkt@c-G(|7Yp{x3T}X zvHxy*|7WrP9asL(V*lG!y!<~`{C}?a?=bd1QKXpXk@beN*fEyXw%u$rm#CuFP-E z^yQ6VChGqU*8d$zzn(pRa|TNqIbv;mpkJ&^kIs@5VyRSpz5d_=Rk`Wg0hWJvW0dSE zE>V$JF8(`Rt*;Kxg`(ea4fOy2c@=Yb^V3yU@1IHP)VK{8#TdJ2QvNnz;w?YZf0!}g z=^Jx@E(p5HR-}khKgcB`D>qgP?%g5VL;7oE(+!QxMXfE`_6O>2Y(QAdM`pXmFQL<` zTV|hF=Rx;-4MfsE=Y2Zy%V?IVwe?*Hsf-0VutU#e20BlE$l9KMgbnvvgh({nj!0^> zIM~Se+PkGHxn14d}vzFY=vWKkVYvYGtC?)OCFJ09CL2p z57dj!awXQ{eDp&GcfZpKy^WK{UvE6M(&}0eGwwOlmf3TM7pbidKmTU*^TCtsW(YzU zku_zsmE4TnJ)NO%&7$NFHY5wzU1i@`l;6yAt{jXM>BPMp0qAfOQnTZR<_S0@G@53ipON)LCo z1B^_53z?@Che1zGOcL#(z2R_enFoxw&ps?ma0ZT%Gw5e55IT&tWK8kQ$W0xx$kLMS zkk;@LdA3h8`?PXv4s+m7w$jQZsf?ddyg3-&W@8=o` ztR;p+YwUMLu3S+qSZ7R#2$mZ@L&Xt#48FKTU4h8ux^}L+iaDQ_^?LQ>(1~=qudz-B zj2NyeS(ZWjjk^rWw5fjEj92{3L&A#gSNxCd10vC#`4*ZU9Q>x}02bFGvjE0N*?vNE)j^X`j zbd_aK#PZ#ie?#xXH>tyERjvDjT_UdH#!P+Hz=b|`lsaQ?aHrkl~@YTLFG@`1@#&x$%hJAaJImBwe-$iosfa~)-*nkXfb zF7K@$Wbto5D+P|M;0Y~@fxmJ+ftoKa#76&!vm zYdRto<+zIwvX)Q0|H1_UDDepxEhk$2H)i-RufIVJ8K?LvW(J;qv))_WyUKtbv?7+{Ux{G=GjF0;NHKB zD5rEW3}QOpKgUuCm7FmL1C`suPLM;&L( zy!_~%DEq&C`=Dz6E2?q_c!_N!ho5M?!kOYr*$YLFmx}ala;BG!NRfBiTJ_#IBhA5H zbpgLWm!6sJ2WE!yxbX%ENgJ4EvWnTJ?*oWCz8ThWa{Pk7z5R0;v5-2TmF^lP2Oy4J zAlql>4L<2WUm5rH{{(sdS-)2?TF}z?`)xV8=uq$eMTSf);EYGPetmZhD4GyYe~izR_t5sfc~6_fBWPIPxG%+%18kuh@EDswqVA(jJNo` z2!EgG69{4s8MamRRyEpynXi^D|VRrBwVsr7$JDEcnAH zckVd0)myxEflAH%nc41d38a_i5`giv8;{RA<=n-BJF_c zo7_{##i;v#qFm5rcz1ZH7n|eOO;n&znjSijWD4a z(L}D4eWDjp7n1etG z0jKqL3j*VH;!+nLcg~DtiG056Um@JJTlYQC_oMCK9+K?cYqt@Rg^5Pj%B{VQeEKK7 z@jtlmdYL38fzr2FFC$8apd##j9v_&wE=g~bwCIWGqJX6yYZ<~`7x0IB3lG)SNGnnd z3pi?}v_sUE1?T33nBNK%=Sum<OMqe9kCWmI@hk@_tPd9n1_@A`C_eM25f(BbXVE+C<>$DBm5;V-G zq|$5XHS?q|a6H>@`Ne)nwW_9RaDB;sx2~f8!y2=lqvM7=J`&@|4;JkJWWACsoRWhr z6t^TYR}t2Yk&gjqPZVTo00)7IScAWX0CpN9oUjJT)x^I~$O~Ngyx(H9*N(Cj^O~-r zK%hc6EyvApS-))Fe@#!lQ>SEs9>jU)Tu;!J-75Rp(Q|Px#cqt3*pW5oD_QN;HA+6< zKxA>WASM?4hZaSvDMD%xbbDmI$IxlY7%GC_>bpDOmd84^eOhy!#rg~F!%OR z&f%H0zr4OF(%%cI+%2b%@cF&^DCIA*yX`kaxMKv*muPqPm4T^Nr% z?fCZ;_#+)kB8@q+ixT)VpPj{#6_^ZkhyS|RbrR0tGtW}qs;W)3)jD9HiOoH~8rWs(j5x7SB(#%*;#VMmsHJO_^h1LcA2@ybvqlhDcPmQ0dY4lkHf2~uL z#!4>1vwp(8U-#$fo1eN~1T(KMo0YDN+!DdCId-=$C-Z<^msW@GPk;sfH~BPQjsNbx z880u#_;F$Rw|R%ZvE^^<3wDXeLO@9=ZT=}7<@cjU3{^>7;KvIKo`kNNLFFX}mR!HU z&T8fhMOW`Q|Lf7{P=J!QTyfRRp^yc6HmeTteME7I|dg-5=t6n(p#4$qsSC|Xw5;YI$w zht6!@?^CIjl+R1p1Z6^&&1B4DeElFfgPaP8WRtDn@}uPmmEiyDCMX``0p$&r@+V_H%8L5G)@Zl_9yrbW zMD|5-_C&-F3UJf6t#Y zB0#or^%}4rQT4C;c0JvglKG9kXHj~g=np*ZX0gaoeI}+nAjm@@8tnbB?kgb=YFo*Zia*00RP`^jzP4gHtkR1@i>qiynzxLI3oOq807}rp}*N!#z0l z%A+#2@rSh?Y$t|_+y9Q-$R%+3q@`jTY+^P_(sEe;{)F45mY+hd@A}M`-*aTBsmt6u zj^v`3ps=a1*Jb^3Qz*eKI4Y50+eG<9A3?`mfk6x%BI$T;;r%C0CoubI7&zM#`r{KIKJSv z%Um4MV)*~qd&__*x2_HNfMTG4k|I(9(%p?H-Q6G{3`0sw4TuU#OV`ld-Jyi^&|OLm zJ@haPFyGC2pXYned7ks{`}w`U_%Y0$d+&Sgz1Cjqx~@g-Q4=Ry`C-Z|zuLg!Yj>82 z?{&A{{>1x#1^A?+9x7SVzR@Pk!2vm!oy@x?NsYJZhlrnubIKC-%IIr!b2AlwAip=;|w9qAaxr-Og z>9(iLn%639GKvDPRiWx#L#p-e*q}*O5-;fKI=@%{M2;2_a?c#(J#W6R?4%eKS@4U8 z1u%}w^0xgcA=MaG&V+!qu^jehC?wUO?5YYJTpiSv`=aKqz}y>3*WM34pvr#th=@Jw zU{kP%@cn>mHa`)Mi$1v&l6W)KVuPt3m^yO&)7L}DA}1jBaho3c2tWKpX2^H{v<5s* zhY*s~Z#rU+3((fOW>LxuSRoL*TuTiXyH*s6Lyi)9eEkm}o=AQ3>OIM}Qv-7J*&$pG zWMW304sXHOnqvp``|woTc*839=d(a_#Gl5_Ln`Dw7pEek`%G$em3G9b2Gz-vZ*fga zpS*5cr((Vq)OFJ6r;R2YZ-yV{o(ZDr?PwyI%so)H~Ty<=9FDA{~ z0rw>3sXT2qVf)X!nd_gCNFb1@>G-47L{0ps+wO?Oi-X?P;bg(m{7?4H4uXQX?|0dh zq~>f)To0~&lHjKAC&jK7mU$!j?dlpdDpvWl>{F^?2$1z)B01wMKw}-!HL`!^gh9d6 zH=v%9e4OnUb>xEA`S06}{`AHiqK+xtxy_<^;C24imTEfu#o>~ASh6FpB{}RF{B{}_ zRgAyNzX8EQ>EVJk&+unhm(KJ$X!UVZOaAER@j5tvg}OYBo?6dka4O|vrI*AL6a`Qd zD!nZ1PWAq3JNz}Rr&Q5@Fwu?}aNJSMrZo)E}QkSH5-rUVYfM|4Aid;sYO231%&HovZZppw>MZV$(Qm z&BxQi!)i&wuJIaC`#^HYT3jzV*;$qVRlJ%7GENlKikYkS9zD!YkrU#lzOT@LRw4_ZaWbnYc%NZ#j@I zvPRJH13q2koaUXve|W!}8^qcRu4{Oo^+lLLBT?L@O?J?!N=kfa98mrX~I?qr5`G5cK)$sqBGuyk{#6;jCydv>M4kdok6l){9x0aOrl`pG{ z`8PCX9zBYZes2FKf#Sc`=SA{}t5ydj_8X z7x{lbdhh?1_s`hr|C1rHaM1W&ppfR2GeQ4lzBi-ye*C@-o!j_UbfWMmN^v;$*?%~O z|9Jv~du&|Tng*NSnE% zO|G1cg#UPWkpiB{>W5<9KaHHR5A47qQDijhhku&g|NZR$yWan|$p7zB(5V0a)ug1D z?R_bok^!CP=J<+(*WdEx;=&AGrD@1XSILdUuQxfCo zv41E%#bDyHcE>vZG`?@HodzLvZRV6xFBdi}_3j!19l|nVPp@=>%=Xsf4RW65QvL0W z`o4U7J2v2?vkPq9^B^6A-X@${YH`!6es5_}M4wSO!*M(3Qp4=xK;3nEAe&cJ$Rj^) zsIR#^85nRmO7GW}ARes18Xhq;w76K;4-{i0F_#0oQ)rpvy-$VYJ!w1h-8BxQLYB*c zZ5j^PW2RT8JlX!eCy7nJ*Hnh`it7wUoEWD68Y_N4rAa{vqxKS*dM%P9Xh&zT`|Z-N;Mj0rX4r)xv; zGkRT(m729wdI61AnElTl6a~;rkAtqwB~TY+)hlD6Nu;6tgVb}_v4mJ)tfpCGmcM$O z4ek#jbTr|Vk_=DJq6voeIF@E>*j@&o5Qt95*7bJOK2YSfoTAP%zmhpB^j-qM$Ry>1?oJ8E8`Sf;9QgwCGgutEX{XToNKW&K;Gfi9-^sAcq z{5~11dXH@TLu_&Dx@*bE#d=KsSZuVpX3}SgNFYIAJrDAyrO+;}LvVSr+pdo9p-Y@Q z*WSPtUdZ ziS1^EydIMz-p>w;Ud*l?9L0$UhX6CYIP`K9VyM9^Uj`0NK6KZ$F(*!WL9O<6xD7od zc5ybn(K^id1m~fLyK$L{R`otE`;e)Jb$RXXpeguAGsqJu+zIE8oDnJD;K5_mR8A)HG?}b%TI{ld z0{3(AS84A-_I&e;f&!}Hp*q!pr^E(cvkc1lb)hM(0tOr$oP$96#tj{so&s9NaI6v! zwYU#}Qy7ob#o~?;=QMP!0^Zau5eB&?*Do90Rn%J1;jNsOgB9GaGux1oR^JD%=N_!d zBzycMEHs6@rGNB98t8WRTt9WyY&P!Os2{%=NT%Eyf#wLfjxdyy-*>h2PbRDU!weDG6O~}zcVF9Tt+>umCc1(LBHq~-6 zO0ZGv9J4A?xNlpG>)6^U;!u5i-~$1~LgJbDsB)?p9mMofdcoahIedz@!eIQ)sJRzW zkibFuP71z~0G_AZe9>~u$98T`|06%Q()}dO=Bd;DMh&0p$z-LZ3ubBX9PebF0o`#& z@NyE`6vLAIK@GK?JiR-zu>)q-6nbfmPZrN7%yrEgm+fmPMd9b8ra3y|+ zXOw5F0}v9KfTh=W-b(jIP#kw7+hve4s3sue_tB%yfh~^3CK#CuY5hD{dNzAG2D|M! zY1uiH@y!+6yEvS>byabrfP+z z3+zeZ<{7pZfbvM(J6B5<8TWwwyl5U0(IswJ9c1S{Ls3xAZgmn=kAFeetv^*tO1o?D zdn-$CMK!_ScxU^b3FIWG5X+pOJ|EFaoy1tGt`Xxb~S8+N6+&zh$ym7bb?M+OWT;FQllLVpmtpC7?2fnqws0J_t3k0Ww_oIhxu=sP@|& z=#@XC5jEq9W@o(>@9LT9^_yOc#gW%hOKRPBBV;;)epc~H^H>!X7H+(AZf#B>ww=!u)krjLy!2bMqj2AH ztmKOVQUan$|6@qCTJ2J!q?yuHs5(d67@&ZqkkbuqVd@bnxVtY4?Ij=%2}V0}#q_H-Q6T;e#ADkywaZudT`=Pd7(Fr25# z>+H&DNVvW=y|O$ne6@5s{xQwqjk^uUo!vANo`TjD{? zMN~S?moEw&^&SCYg-UN0su4NWRUtukzI8VJ+8pSsBZAQ z0U@2|pji-r<`z3D60{4$*??Cr8Y&r?QZRVGKdlUezjA`?F%CC!$R5$#&bz?u!Rw?^ z-dCPqPID+?s#Smg$T4V-PGkORcVu7EH_JaZc^ zHnS$CMUc9u`K4HN{{T9sOe-u&6Mj3YO!Fk*j>KnC4mdc*!=dl)6@K%p_)wi*(m`bh znO0qEu!wII&A_cFB1s(Oy?p#_lAz7$AC zb7y_o=J;?@Xe#=)>m@)@IWw#vrdXV9 z9%qR%AaZZ-%5lsHbY`!Gq?hpht$iQQ95c#t+6Qoa(T z_T{>e#nT+oyQ_fyFXQ-~$8;Y=ZBt@!Ik)BsO#*VeP# z9ZS(q#ccC~Oz|TO1b8YZ&qmcNpbjn1KnhSZ0dNrbPndLz3o;hVbX#l*GIB>`fODms}D(rK#Z0Ox=%N;wSE( z;^fepUE7P!I5n&tx{Rzh%S>;2v|RK>ZfJ`tv(?L*)ex1YXa9b2a;xCZn|K@JWhMa)Gm0LTu)En$#GhI) zXrB2R4h3sjPpkcm8LHxl`j`B(Ocg% zTJo7bHu_JzFr{cvdiKkx^H-fPV)iuwxz~b?O;%}I~CToD*e?>ersty^~P`iU_8mMCQ3tAdE4O>G{1RRS$um`?Gs?PEmD zRVg$K6i)GRa)>bEy)CG%hOnY72&?Lhbul~n*Kw!W)vJAsP;ra8jam~Y$Ev%YJy^FI zq0{|p?p^NGMlXk}*fD*Pt$e<6U{+|-1}sLs6}7D-oAUJfiMK?P+uu{uAG`oIBTfzw z@Uu_Z$#ufsa?S-zn>dtw8(I7OOJw=Fk`D_!t~39d(s#OVk_`mEg!>)0kVH%Sz(W>S zlDKxVV2=VD@@0T@+F=l1>Kt;=` zL6bEBs_|w)eej+PSGPp;BLV0BhsOhJNgMFK@$5JCZ56o>W5ig`=CiUJe+AU890A8; zTL698d>YbN7o~kd;FBt6~rw3Mwo+f ztrxFg1caZX)uj|ex+ncGwP7t|zA5%H61jLXZSR7O9W7`^frea245L9&T~c^* z(aiEKE61M%ejS`<{hD`d50tXI_eQ7&@vAgJ5WYJ<%MglPmJS*J_1=i}NK@l7mA<$z zT)t(`8Yg}v_1*eeF+0>DT_cxZi0tWj8Z$;b>zLts&-0MgTvy}!rWR74-OhguzqR@r zIf@)@#mt7ZNMZy!OF-RZU-{b$q&1dE3^iH1*X2hP9{51~F=)VUjG18Ym@#;Cx14QN;-X;j?ezB&UZ`jd- zMBA89N^}d~XIGI@+;+?DHq*>kf^yEj07=BH_x<*fN3CO~@7$)c5&tIbvr}cVnn@3w zu=qPdVoTRQ_Q!o^|a={8wq%Bsf0$ZSn}Vq-g$~1*RD1y$9RE;4Nh_B zz3}#C;kjXawxLa)5A4{~-VolUCp^z1pCpdyy-`-w6g{5L9MDqof>ByoGNAHkp{iZ- zM{`;}x?INxhF$7xehQS1$l}bdPnhq9x>lwK4ec##e9Yg&i=3>MSQyC`b$)bp<6+1zGF>-SZ za%Bia$aG}G5#I4{GRdBKLyag8ak8o$kl>yPDfH3hODWudiu?bY`}pGn%X9Tf?C2Ki zy4qJ!(vN>*cGYQz5;u&dQ}ckY?Bx5G(L8^;0l5^e}pp@vvNd z9Bo;U#xS3DDz=5v8_ar_m@rVUj4XucZ{T zIwbxUE!@44%#)~SkHw5%TTmspP)}_q3j0I_CG{CG)#Pmb9tV`vUNRJFtpk6DNxT%@ z^m&Z*)mx(QREO~|{KlD6WSmX3F*&d@g!`|u!$Z%X$qx|y#8J_CeX7SJ_saE5A8$u3 zVZ1jgxb;lus-6JlSO&bit_#sEdAHBIN}m?KHxCcZku4lyiEHxGW(`c@q5dyJDq zzXX}{or;|IvT_}BEdHr*OcFIVXOOBv#R}cyb@i+-&5BhBRN|!I1tC-t2I%s4>2pb= za7)d`Mil*nzWb&#o6P!~o-Y`mp68R382}2o=HCeBeka@tY)~gpdSOq@LIW&Xb4fS~ zk!Fl&^6dwzA;E;;zv8{P{0RZ&xWab43&VoM$4f!<%kBy@~ z5Hlx{S4wYmP$zR;tc5a(B{1FSZN^~{uNj8f(diberP>cIep*qW`$1K}>~l*?15S1( zk~X?_?pS%fXGSEKsADmM6RlOOKJ}2ym|!hg-IJ%K{2R`-;@6`BLoDzawf~>-vfUHa z%zD-55h;#yP$NYw1!ygFGc0$5de4%JI#_r zojG>%;6^s{)qLd&Ue|Ds;4G_3prU-TN;t~L3cY=MnXhFJ1u>~wIX(w>oYI%azN$C* zVI%Y=n$l&~P9W<2Mg@nNl=pfJb=d0{%fzCxm7kAlRqVf?Ov0By(3o;yTEz1(Sf3*( znOlXocHNS4SG{>}8ce~k2>L!?K;@IHu>VBV$BbLo7K^zMlE2qzNIWB62vM-elT(0O(8@s7-jI<^eqaeo#>pk`2E&@)(uIYVe7EcerMgi%06*{S*gBPdT5q?$v(E>u^RNM`}cWeYFt_*4E5S^*&AXzN^}=66g`>dooN+&ru3M;WdiNh39!>`y8=X_z5#T^|a^ zK|8TCV}TFtg4pozj9Z-js?W3VvereW&|O1I`46Lk7cl!n^%6;Qypg}U;!;ak=ivFS zcQZXautd(P`0^)SR-!RS1zNlu0_K1m5G9D2E-gAJjW=3`0&$8$XD2bM0(VR*!+m+M zgFJkKUOQ)!vyd`pvDxCa!6bX(;u^&*X7-=6mSm2gcr#mANjS?ZkAdTKnLS6?RBAf_ zDNpz1AAROBy8|H|ZSvpS&j=b0iNmhqG@tLZ&}c4jnpjHa2R~vc-fC-T8H-n-l85hB z=Lt9b!P#2VGW*vADS%B)kkY}G2SY22$F)Sm6rd*e39l#4fK%dHaLvbcgB{Vt(xv3( zX6&(cClAOBStmoow=5{sk)tmyS5_TmR^mVX0g5Ay8hhU|UD~7G zd=~_+tMn5h+-FA|HMY$-g?mx*UbSD#p~^|xxJYGB z{Ux_sJc2j(1TZ4L6OTo$^mpAq2Uyv(1bx*-W2|W>t^vItFRA@GR?(@1ph`R;3%_dR zfuH?TgQ-{fjdOSI5Co@h&+Odt{JNxJSY8?s%V)2RRJ5=hmp#o!Dy#;bY7^i2OWcBW zZxD35NK;Dj$okQA1yOw0#Y>7!p~6>Qa?|W#Es}4+feJ#bNdxV9s*`Nla%QImcFt;8B}`c$6LlUJN4lYce1!M-!u_Hr0c;&a&g3-D z3vqm3!9Wh}GL#zcJ+^R*f8Aspl^Jj{+0bV_EWyc;_9D}6i!?mE#b5eRmXRJWU5R3B z6IbY6@%oS#+C4&mpW(8NtkvRYSo#Wnk5c!S?YE-ajd@@EGnXT*3pe};GMj+xyKMFI z`oyGvYXK~h*b)lUbJ%X#UzU##oh_!jrWg#243y=86v>H=B%u`En(Jugtpxz-AtDLZ z&(n8k_n2pjnAxO;gnr`8#Vb|EQh-aI?h9^QidKD=p&TFd!P{YvzVJouu`2p&p1oU; zwxBs}MpzyPK>av|=v5WfyZ-8?0RmX$jpYM(yflTUAp)C6i##Hw3Jv38WcYL5D5g7K zVa&AwIbyE&ABdz`hX@0J|K+2--FQVQ%~^%CTM(#A>9j7;bJX6&DsRXJ9sxIefwK*Z zlMo}tl^02Sp&0}Zn!k42+Mhw*lvTD51Lp?~%jU|G8Zir{t5?}=DR0jx4-{LVh<=6U zQrn1mVO}W@j+ZQYZGgp(^%Ge~N^rgiG2$o}VEy(W9Jiympcah8;b zfej&(H0S034C&)Mee-U8ZXmJ5Y%L)0b=ua5kQ%z~YGyo_v;M&2o^v!Ds3lBG%jAIjRn%t$<(L2Q6P&tG0vRO-&q%kS1@t zo>o#=eU$_BkU;gZ*kc4l`AMzl_Sj9~)$KC;d=dB&&p|10p`3eY$?}Sd*wb^qpR??j zyO-)$Fvs|=y;j~3?5RZ}AW}o!O}6cf3~sC%6!N%INJ#`xQ#_XG^92f0KFIz>UJEdD zB9d9KC5D8tf1QjY<~B)!Z1ugg<8&mD^X*%*;(*56Rtp;a7$=ZNQ0t+mcfnu}AoZSt zr>*u@`6MqyGt*0GbYWJ~x8S;}Go z2*b%PdO7*7Ly8KKxX0`p16HcCWSvMZ&RTx2U%f;OeEzyM(rL_-h(?08aQ*yAwQ29~ z@dGJ9$oH6(0uXmrW_FGaAg(*?l5TQy1etdu)1{O_Jma~seitzhJ{{tVVzi*Do9*` zxSt~a4q!Z{zR}&;ko?p=DgPmsKUKBTd`%~Jc4m%kw3iKRInw*U79xO0c>%*Oy|C(k zNP#KPnAmzKE~03HDYg$Vb6&l0o>K=lK27?n`Q`cTC=M9BfpKFS;tEp;O}p7Pzh80o_-n%E zUsM%!Z(t>IL5dNz^chK+d^lHMoL-O*0r`&_5w_WhlF7=?vrWgE*5*G;C!@LY{~ITV z3p}g#6Hd+l{sf>M<3#*{J%;T$(D>%Bw}F3Sht!_{c!ZAk-=6;WY_RSDu)Rl7qzy(e zoPQj-;|7)cGj!swFZJIz#Wx>-XR7(W=)&>jpGGE@1+ey9raAxcuKvJ&@CD3wS2>clD_c{&D2bH*}XUvci7?V1361s^#Dh&FjWo z|1>gF7yz|4Z;}58()J&>NrixCda%F_5B#T*rObh4#9fuK{ihdD@f~<3!(WcVWDkMU zKI7zeo?5zj8~R$V+PCM-I`cCriyxL1%z1FeN#%HBXmBNzpWRjA?f-<-xz7*a>Hf)_ z?N9CI08Jl0`F#sq*@E!8M?2LT6mnb1YCrLyYJ?WaLt0OK{x0(Zd?xl*jTp@eD+M zw^WmGq9+tEvT$}ir$ujg5*D&3zJXk{C8lp{j;3&>lb&twd>rg~6)aaPx&)aQ1Q5rD zn9dM6va_ZxWkBZkVjto9JIVSGaJri;ir?g3;zZvVqf{JGffjc3^@kg7*@}_N`44pB z>9i5+lB(foIexzT4mqWv!=&oQCrf-KMcqoj8zE&#@`0;%ng~Vrb+Tp|E+7`_y0JdJ z6jFtNz?iKI8Rlb)nT|?3Z_7qpbQpWCQjU^bFH3rG8#y)h`FhsEkqtr@OmXsa^*sg* z<;$1XCCv|D`DvUj=gD42No0%6d4SNla&bKS${xzA8zU%nI?+ykQJ)=~=WnSEbJ>gM zUW5s?#TvxurQN<`>{5!l(WQ=5)HCLRFZ*I9G}8USyX9(m;PDsMNp(u7VEy{rM_vRI zq_OC>D9j4V3Rp1#hbD4>My#PT4{+~V@e|}rJQ%j4^|?fe?k^lJ2M?mDeV=*N<8Qi_ zf#-6ZV;wKmh?JK@%OZw_-zLXgKr(Y zSEt)WM`FOlVs_U|A8ek3fB6kt_rLzIvjxfA!~QQUMo0yhXtfb@%R z_vC=HU6rTQsCKaJw@w8-!R$rS&v1(FS9FR7Rse#0jE#d6;8is=RzHe5sPk|zH)R{Y zO|M6Gip96!`};GQM{|~y1a`D2Ejz)#344RIH~1F0^om!-rcmCRBFkWpjpFk5uVq}* zoXUy;0etziYiKeoW;4y4fg6RTeV|#zJ~9yU5DUCi|Hti|xy4(z0Ue3C+Kf4CPk=LuzOcWJ3H$wzQE>Nj~R=~P!2BlU2DJfGnYqj9#rKGZv7$<`=9$lrW3 zyndPA3?lpjw`9IRqtoX7>~?Y4Tit35W778N_fECsEne$n9X-?08;-%o`0sR?4}VBf zU&R@;fVIZ0f=iX*{JQ*{EhpZ@>E?rpPS5p>*Xuiu24t$S!G0gzMf2mcS7B{+@boV*zFQ!NCF|iuC`N6CK2HP2`uxuwlol`UN}@~jA$63Jsbcn0mrAM!PuI| z)=G)rvSm}grTdxRiiMDM+uPO;j#-Be3HA>VnV;xc4&De62T@&Lqur_jF$lKl+-&Y$ zm5m7JNZhmQFo2Ei1#hJtO}lkAOGk($HrPyc->dZ&>Wjdqsc{iVp`m(9sgX-TGc5+BMa9yG1l-izauUzNg4apT?P1|3e zuSPP}g$2z3A{Q5h+*KVS%IVyl4=Dx49#Tk*DJSy@+eX@zRfcTMWcm$CV_7roep!Dw zZ=EpdS7F6Os>i_^qya?G0{M0I70~XTj4RAzoNi@Sblcr@E?#R`7(TW4uO)+au{dKDCB^K%HuD`LjSer#S#(2#wjJ%$PY)8N8>F1N{g_Tx`NMz7Gaxaei)XkXlurwcq!U+#DYADk8U92Q5qz*-@}1fF&t9%rJ>uGSFr zATMhz|GfPyErORQfpHJLR?RttrjCffM>HBGyk;zMDU#@zDwn+CYcE;n%y%!2ALSh{ z+jCLqlY^XTLtuBKt&7KfN{>d?2!{4}tMl9!T2a;%Izoq?6X5Y7#&n2zTebU@z7gEE z;~w|IyQ|uvrk#?cUM^e)U*+3@R$%gcd=-r+@mTiR?wh1(ijGdvwxXKZSGKnw2KtBXi;@*EPvQXsvnCW%obmbum;<~#i9edeWI zU{tSKa?8(IgEEijd_CcC%1QIp_?So}qG8f{w3!-e{5{>Jto%XY-Akjh9acQfA}x?c zw&&~9&bd9k$l4Rvy$6DyN@vbKr&C`AL4>xocxMe2Y@ehAE;W-lT;*qY40y~tl9%qN z>A-Unkqj|~VyxGQ5jUfJHY-r9_F|d98>1Z`cC&&akD#$adm}b)Q+rA=+nPBMB6}l{ zX{>*3E#C=SdcYcl`l&#H)7kZK*=Q;0g=0_d;~wSe)>i%_KVI1Ne!>3KAoOWn>9Ux3 zxif8vfm%?fT6X0%kbI6bLofMY^LSd??K2_gNaKw-e{e5+_>~7*23j(h(mT`t-N+%kXoIKD^&~B|bga6qIhy(R%cAGgwSn4*YD+FI_(4L8MO2 z6+GQ_5Q-EdcAtq^QIr=!pAfmcPA%$B7cux4Y)UTd5;5@c_D3p4Y7+kb&Q%B%OycUj z>!HSl7%V__qb9y zcLMkfk{JNnLjAji7p4$oW)kfYu3qj+l#*Kwonfh~q=c792C$8zj8*H>O}zqtkyH2k zA$!ysmnk%}Awz*E7DLaii1>NaWf9H6DsHgck1$KEp!5{qJ6`U-Le6%I9bXOzyEpk_ zH-eNbRIPR#P0D$YQ5z`Dx$;(So(r37_p7rl!4Vwf!!6Gr!lUtzJQr0wo0x=^TFDXs zp{821)12*roRQk&I_re8c}B{JMMRq9eMV56fuD)I_%Fw@tP4d6+mqB_?B?N2xyO4C z5(xYY&%(Nvb211#08!Pq8}D@1b7z1(k}1YYGO04}zA(01>60+yotfn!ONqu$)qN@Y zYS>};`JBbYJ@-Bm!Q{fTRSn~rp^KvETbDwNb0LT&2b9!PiMJ4+wk%Jh4s`A-^ji+H z1lf%Ylfq3wZReO5w-0ypuV8JKk^wJj{U%|0KIu2oQyHoECvdU0tXVBK2Uo&A*|=`@ zr2DT)CV;W({PzA>Ig&iD5bAOQG#ILsj9Sg&JJoshavD7H=2|I3|m)XtjAtla*?CMJtPh`Az2_!-L+%WTZI%{eVgC4fC9EUZc$4~t)wx$QG zb9kog`G1G$L8vZW#uCc!>lVb;rah<%bDbh1>?W4x<}G^`YQ82|a4DORr`mQH-<&O0 zG7iCWy-{}F`JL`V{hqDr;W(sqUV)VJx7XZR`Cf$G-15a4d2C!l;Ct3hgQ;dp!3Qa3 zJxpb+*~}hI9^x?^pQ^n{F3OY&#;boF<+;U~4N24OP+nU;$zCCv5 zbSGu1)aW&-U6s7cOGM%8ap^!zTi1PggyBx?yx6GR^QE%$Mu;-40{ouaET{Pu;Dyi+^;M4SI9F-O9dDj5jKyq&Ht7 zW}T5gaijhE$`~!3)jjJaf#1Zps2SgdXhDAfn3=kH96I7NEvRUX*xEfrIObbf(UImL zdgUn13DxG1zhE)X%FzJV8_qEk?CUr@&u(tE8LeWOCnu@xrk{DZ>#D12q>Qbbe%;AC z{Fx`u$Hr<$wq1N{>A~04Yc~531ccfbt8m0qlmjn!FHmwc@T|6qG&r1s(|khiz#kDQ z=7#A_o`UA*n)PgZ4%D{C%C>r+W-UwU`LnilO*V|)5|O=0YN+GiwrvT>flVff-+dhp z;@=3u7vUu2SsOV$alL@=5@f>d61VT_M>Lw;ReBCPgVqfunyOv+RW(jQCZ{7)r9q-8 z!ELb(zw%4{E;M!>^Mg(OKX|o76chcr+y23D)?mi>rHZcf^&@(}tu4_5LQJ#)fWuR7 zQxz?Cs+owabIM#3EF$*2a-Wxb6>co|N-}5K;Ked$;tNlAI|;w6EAEp{Kz}5SoGM?o z=f3XAv8WP21+x>MBX6jNZ(%pM-G{P|W}KL+>rJTi(y1J{c&HNk%8}-Q*5lvn4+-@(QPhEJtA6g0Jq}tOAMr4JS!}y+Fr1^Wl<=9^#OOZTGkbwrFmuD3y2$Bc*?$!{D$W zTrb#|RDblOUO+ckMS$z>thogT@j$PWItoaXZ$iEH0}8kcJzpWJgYYh1J}+GIV&r3q z2#U?SU&QH+q>lH>pD(X9Jh>DNCCT*y9FWxv>rJrKDaF}#c`?WkDY6@2qaWmxZdLmp zIP>2gJ(;FaJ}wJ3E9dXp|9*AGH?*tHfwMTgh?IQlmo({-`hLYox!}-y#W~nIh>z(C z(ElG0JL#1~%vbz?gC>>0M};7kzGyAVPgowwR?{|9BUvUTler?qxK+AQI^o5<6QjcW z1s|(FIZZc2s#f@)4EDMJct76@6eek>l;P`9=DWaJ8lvKwAO2?2Sbg>Hbi6aIQiD`X zAd?s#WIcS}BwUhM77ol{2e;~E%;|$A&104LOv%f0S2ts7f>;7i|2eN?2jnaP!*TGe z0$-eap3jmt0{@wd*G8kRUxun@@~`&L5KeRD)9~V$?g^9pnWp9{WE28*gs4=<>XQ^4 zVzb|04Sk>L+woiW)pwJTN4ZL+B%cGfE!^WxP)$M#N*I(@s^-+R_r^u)G~JG%ikHi2 zz^9ZPgBk5~V+K}DRvVTApz%;aW*V;l9BmJv;P8eo%xvCU&VAu?)GMnwGLF(5tIX<( zMmLt21nDKRuhf1%pnCU(+L-vZ?#7kP`j=Dt9Ggkni#bTSb&rUvCrsZ=U!rlrAU^Oy zui?dp6G%Ic-D5AjUapKXmhoz;zeC$WS3KA|jmqc9>o^cZS$YM&O`n^e!N-#PS>^yXD~d8Q7X=r+)qb)R z^5{-#NMGKt7b~LfO}xkI!|=46#-}9vT{j!ufpX?NvlFF1(jyM?#nbXja)X|zKXchC zSV<@+M(U`%s4N@Z%r89$=LLI&^L3Y(1gsf3e?mdLK9PW0U|C1(A3Dm2J5_nC3I}wQ}|6743zh@8^lB|hZ6KL<1?*E%}7A*(#@X~-|Z-UZ<*)o7fEj?B9VB2>Lg zPsk8Zj$e2atjGN2+ie!ckw&`$4Zf3TJ6=lIo~VP>Sw)+X@xd_-D-NFB;m0(UxR1c~ zcWLwL@S~Y7YmE^M-$3kzYlFTlQzy5Jc)S6!D3=%Ql{>9*g(ht0eHzBwehVX zD}!g`(F48qbFjkT7;pKnP#s>-P{?IxW5W>vyo<43ZJ@ZUnScB}UOJo)b+Xe`p-it^ zWLX|{!lC#_W5#lYvN+4A!AkXmGUsxK`*Kgc$?vqoqN2*1I2{g_6M#n4!3XrY6oyj| z>z}6*rN-SglZwXhT#R}TVKQM)LlQnX?6RFB)X$mHr|KAsiq7(lkq_` z)^n>p^xGS!QVWydWy#TU0v01ry)&vKaWe>2v6fVHZTf2w90P}K@%tZN97SeKF`rwx5W$nYOV zjD;M!2g3BVoNJwkmbT-0vLkVK^Y#VW^L<0-fqp>DyD#)IuyBxgEk$lcB{lL{`x5TF zh%*X_M7fVY4&F^b32pTpO7<4A(|uF;;RIsx_k*#PK{b*9D?76^MnGO=Uv4&vOykSw ziI_L^KEQMpM6HI_6*dQmHSq;X^tf99>au%iLR=O9Ya!)%#s%u`Q~qJf0@_^H#J5Sa;AQ! z6mI{(=ud8>pI`25eo#@&^Ga*&RR{m`WpDVEjZGNr+b`PRbR4~exxthn`9S;2xT63+ zWKG0f3~FT~e_e#tHg((Xoz9*1$3?V~PcK#jhYNU6&4(M!yk<6$m9HA!8d8(Jz3+Y< z_*3tFB!p_Ei#8YDF6zR^8GLO14iQk2dNNra6&3jn;|Ne7l!u}I*+LHlmSe?ETs1YW zeKWg|JA`R)e~pLBCI(cdZ&db4R*vBL>raaDogsP)hkS@8&cGf#IyW#Xu+RzXcw-)s z)Qs@q3yG(1*~~~SgIMC+`|P1xa3qt*hZ@w2Oq+ClGhv`j$@RT0*gJkDaM(CP%L)Y# z{&eizgRoNHS`@^1F^z2v2Zn7xf(4idF9HrxkX6g`MBOCN1JCmHuP>yqK z&B&NYf$IuNGC3vGPjwO8-*+GPX!P*CR-2;Kd3@>V%xjcDWwSHUpibiMX@#I&K3<2{ zir~;=S`%uIGuq&5Uxp#3xCY4d_M(DvD|Vid4PY6{+jK?BsCpS`7TpHKr?AlZqgIi% zq@;V|)Y=eJzQN0BGyl-r0{3B#y+y;cDrjkoK#{pJzu#tb;KlY~-|7?6l!O|@z(S+{ z?3tmj5#ttBjenr~=CbGaZjIOqC_FtsQYE{zyu2NLMTuwR0km74CvWSen|^SM<2;{z zombIzXJ){t9{0E#ao}sV&<{uV40m>rM&0zU$-Xa2938~8Ghj#h%dJ(yc zj|ymSc_#x+FJAM$7uJx4Dy;Vz2%b-AJYC7ARkn>aaT&!i2`Pe%mgSJLm z7gR~j5w~K0`fDH*#wDbT#pL|z(J|=e?}`yg;W10#j|_AYhMNtDKTyymfGkKqLE#kv za&XC2Z(Mz^Xl=doVHGO{Y}{Q8&m7m`jE;+Hf?H|sX=4e06h4yhzdjI;YYj@F#}S@) z?-b^!fo(5xz3x^!E<>-gE=wuAZ2NQqV?8%Zx@9sxwDLz z?^V(>G$RhC@m{wGBaMzWSs`SrIz#J;;T6gv>xd?Qu_=O0H}yO{w%!+gd$?3u>N%#h3#;2Q9t9G8LRCW%-jJPh@V73GN2eCoRqhoc{ml41Tf+D4XT!u_> zQZI3iOR1#sRdzJ~`bgE^ixnSo$?IMNO)|hl$xA=E4$gLx-h~ z(%!UF8A&iKGN?%l(x9b`ZfGIy1mf-P`|{pSP^KOKuT#6=X^tmjB!)Jx1x4Ydwb8H$|_N{kBYFwlVI$2ud$iE^2#-yGq@6Vr1I zfYJglb8Tb=$QE4l&BXyx$G)75NUEm0hp{plY`0AA`6)DB85Rv%x#wPzj3rGqlC*|~ zWdD*>I!5N8ccvHPT7z@otb;GzAIK-aROOWkdO5saR9yDtP;ZvZ;&FD3v0rIK_6r&P zCii`=H0kXfA*{m03qvor(}1HV@LPTLd&QJ$U|oun-gFbeq0DKpjY08&I-Z zB3q1PtE(+xI(OGfUET17qpe7gC7=$2BG_Ux+~!y%}pQ@zB{R( znQ0nbw5hDFwvFHysPU%d{U!f&$D~N5|A)Qz3~OrJ!bUd;q9CA%qDU2xUX)Ixi6R}O z8mhEFs8T}chzdyWoq+TfKnT66i1gmO^b(46LV(=G-e;e)_u1ZG_s{*F@BH&YGRYci z&N0Ur?-=h3MUMs0xpmY(o-b-Mx`nSU7jJt}%(*gTiPsK(o<&H#@=7S*cpb|tpWHZ) zc~C45T~X{69H7hv)TXK4E|%*pEKK(a%$Bv0mPYbRiuMeNIE4!9y#A_DUiu^4`UjLh zO=O%v$GVc5R`sSo`4-|XPlOP8aeq|F;9a<_XnvfNvxO+d_ZKVL2oNmn zR^^oEO*E_3ky5$I-bzZ1wpnR9$%zp_xfl)IRg()~ri=(O*L?9#K_bpwFHMBFk;Nao zi#)^lJFmIwzqXMfiLb6!>AFJ5Y%~=F;)NQC&^+v}+uBWzflPTDW&NBL_F;ogxyfS( z7Wwmw_t5=)9IRXJJ@Xu%7CebZ;VD z*82{p6T=WtW{@;hv^kkE5n{i1$hjN1HD@pUIJ+MT25wcF5yXlikNDv zHxC_or8C|=c_??2TF@%yZdD547@YP0a173k{P*ITE(eIol%2 zd^jd1*<GU&MHbP_r7crT4f0&uifAvR~ z+$0Tz)_L9oEp4ku=2!V22j)J}B9ZG+{qSA_cCzPZJQ7)%+@P?uk}{iPtog5(9g`ys z>u(t~OL>o;Sszav5%5&rj=lMKuQU)87gsdIJTu%3UnNPrMq}IEF zQa)Pf{d%iMcNJj67bg}y4lCG$eQnX}NoqPd(c2rRGBWq)tlN)D$*x-fy1wi3j?Yn= z=Q4E%kq zao%slbgpKuvasZUB%WEDQr!rE3zJUVqt2A;80LhPF)+X-B$)X+S0WOmQQRHud)GnE z4Sf;*?*@=p@uNJ9zM*3jDq*`jd*}yVpVdLkwh@F;oP`3-qy``+3VWn|>L*0xc8yl5 zz8)84gr}@SZ;X#5*iB8Z6=2G3m^3~So5dNlAK9^H&#mm(fNsc2I2gjh*BJ;&_ogks z5HLW|FA1`)(E0!^8`M%CzXPJJT@uvZ6~zZck(4uT+s$p@@-X!PD>br7K#7e316@PcAgw3`2+O&$DZk?&0S062mAA;o;NflHkGq@X z?*hqqju)t1Cy*fkPQw6el+=r<9P}@DdmS1F^bx~TcLx_1GeeRmW_r`?!7qRbChN9U z_e)4He2|cT=y(*4?op7PJXebp2q9jJcuzZPayJ{QhEb6d>{8BnD@I0~6syWVLP>q< zc~sT-fSIht&&ZpWUKw3z3Uu}+A|9P55pJueqn3|HcV~OE;M2YK5^2ibwdb`s8k!L= zdJzAR*!i3$8oHaPIoiHES5DZNHP2;rdhJ-|vu7cHi^KNQMtF@FAo$&z54kjid?Wvb zzVVaBiVDQSUasP1g!5K}?+B~G*K5#Sy%kR|rZFq3cuLcTC|AWqICmdZnR7MwNFGrR7MPR3MYabT zaxr4_enX>x%=!9_Y#&_~@4*;19dfqNte!>>RTcrw?^j<_lXWO615!>{ubtUR&z|iT zPM%|PmM^0D2*%R2uGGDN+lBgPj4sg5PH~^~&kM-;SV_#?(BvKM)>H5mrW@9b#By77 zvEf1f4=s>cHd7j#T~)iPxj*8ylEk#P@5qeZcfP1$bi_!7Qbr7c9m1SjhO6p7ENtlA z^g|?Mg@q49`bBdgD0fNY`zd>FJ~+3t=+qUrw(9YOJ`enU>JTbGyGyIr`n2eEe2TcW zkN_d95uq{v`Zm+b9nJf`DKi|*UbaU*N}Nm#*@(9Wh%Zz{xX4%?8w&x`$Zd`Lzxx=Y zT>jeeAK~Z?zpuXZ-MqO4hravY26>Y#(tKEIQ)mRNxxDm$TG$X5fd=?EvScWTLTcgG}-H;X>?k8Kz|RRkLOD2oD%~u zjoDM;+5SlGzR^I$rNCFA)ItJK6D ziq853@yZ>`Onwzuj5v_TPO)!P?uCH|rE}XY8f$yJM71a6HI&g~fV>(Y1OK{Q+lk=G z=y>}Pj}E~5Nq)6wT^SaEtd7%lY)mU<%Op9MV?%>hqeAwueGUyCMwH@|@u$w7c;C`O z6+K%$ahbH**wFD;4HZSZrP@0zyZj4Fh8>VrB+P;K zcbjzGQUtKuZpXy7k8I0q>aLPHB*ePy%ip`#Qn zRZzEL>9(SN>ZwgZuT{Dk;@MkNyfk3~ z?CDW)YV8^HMl@=|T})?A90YAIf=gU4qGDoTX_!7C7TA5UM^)~|O-2kX&I$_bVM8HUs>`2uG7lu3QoY~61d zN?uB8tl!Du)7TG@FY~Um z4gq!bEoqckKK}xdk6h3pmR|PMLcZBe>&V~D_0UfzQ>C$|TR1r>4Ex1rW)Eif$JX_c zE2Q!7r2hP{uTOHgy`ai~O;gITF?atInv>r*8p!+lI}j#iifN%d+4svO-o%ymDkl9q z-s;0|A0Dk`71!}Q&sn1z7`k-cDu&Q_aaNFS_imHRs+eZ*wOVb<6}hG`Z1=VDgY2&z zoE7}kVRwP8+ga~cxwWaGugA(`bS{CD36Qu?>-9|6%Ac92)%e@bzHbt@uY648|XynqH>XqtD40yQ16vo>ExR3*nf=9VkFiVVfg8({#>S_wGmwa28%_iUaC zk6K1FgJb1`mlb8b#bfBZT^62QKx2 zImt!$w*P@eE96<^SnqBuTCpfl_naS(qULGv>c2ED0mF z8iGxiYG@KEm67iC7G=kXb@AAYIw+zns%#{!ptCTaT1a*-+_hU!J5an1WOnEnaB2qRU@qmIL%~=gTvUM6t8i8KlCX3{4xaqWau? zBFbLe=0N3oVTFy?LHyZE;q`^y42$X5NJ;CW`JB0ruD~(UCT}~&z0gIM8!?rw>a{lp zC%KLI6|^Zn+z#%1-k6Qtx=datwg+OKeM7C?(DkSYxG9G@RUSvVI!4k;p!K#e=GpMv zvfnR*-EH795Xm$>Ig7f!{MMhh&~7k*BJhE#SO9WbtZ z4KD6F_3!wqu_r-Dzin2T?gs7yjP2g69)^4(Od0Z0qt7|< zFWQpTZ{#`P4{VI1ipICzT;ugp{^@g_pXlu^ScLl_9nGc|tJ$jG%ClRZ&uHnrzSJCk zpX3kAerLv?Y{i%AuwI%79fEz#DCcJ-;7 zFj;e#7MRPl^l09Ii#Z`P0H;jVn zIf82RRh|{S+?IRe>e``SXI44~^vof1L6iBN2` z9cGNzcQDN{rlr!!SdL-WVCrX30d!+1C=Z7F19=_REYrlWNwM<1#&-r9(G)KQHZn7= zAKe1497B%fp?Q1hB|EjVe3~)9ein<(Je9@Vf9^_ZyIlpZ$}^^;a|*?JZacyNo@vFT zvJn(J$xvUJ+zJR!{%aZmIjij2%RBoUv>uDnVA|^~{XZqZUo?RL5EcRw-mF{g;Rbf* zGTr{Q_NecH0z8s->^IZg7BFfK78WdWz2iA+nv|{?XM%Z~`hv7GN+dz3 z`b5m=d40r*7*GKyDw+1u)FiKV?FCy`x2Cy&vHi|7ikhDVuqfMg_X87ZG6m$F-zVd` z6eIc4VN_3c>i-4b$JvWcSK6BUu5&rh&#xyw-df#)3~On3iR$0_eZTRnPMA2%hlI^K z;Y<%3l5oD#lg4UTQ$)q+2Z=FlSs;zBiVc%2Ou~lBcPzk7z4?*^d5m5ToVy%8Mw?+D z78q)mm&0tL-s}T&I-xVh_T_G4=iN5DUS~GvalDRmJ!I{?&=>%k=pG%#WTnZ5j*rJj(1E9qMZh zt&@GGm_59(;r&7kBR1>Z+z05h=WGK#U`8Qtvi64ay~bRErnyWeR^B%L)~WD?K5i*2 zyZfDW`6Al6R-ifissBB@Mo=fm=a$INBM!;k8OD+mItBnAymqESBlJn+lcVy`g8&qk z2PE73asGsnG}GFynwu%)1i>sxE9{hp)Vi!|B4uD^Jwvm#Oc zLxb+Xa}7MQVearnaBHujvm?{9fvw!gT9ETA4NXxlCVJT`GQ00x+-z&6WUstB=?PAk zUTb&sHWffyIg4zr-M)8Kx-4nu-BwX>#p5WW+c3NNx5yYex6|6LoNaw~h_g2f%(^N>c_B+5CKiaR+e}5mx%Mrx zYgg}D-?}lK1(<$7Zu?I$7y5AKmk?c@KzFCIH0@1({wzsrhj-Muai=#u-_yTC5xU zvX=vM#SgB^->U(JKs7)<?S7ygWq)oL^tyJ#!* z*)XG@`)Na~s@MA9s+>YI#$Gd#&eq^|`4Mu-Ipv}$?3FRag+KlJ{-&W~C~K(02$dP3 zSN>@E*f~}C&lHo&gBGm^eJ(dhw+o8Vl+mpPB05HW-(Y}n)(CU8v~x)#F1nyv)_hPc zv9OdO{Z)Q;(z9lr+b*K3q7g>SOVR*U3l9m~?9 zCWS9CrtuXo_?$ij6~tE{HLAj(=6AKf)BB~~?Op~Trq;N_bG-_y$P+}|EC-A_R|P?b z7@bJfOI*=D(okai{fgeF>#96&N}6;Rl|M#qG~`S4fgUijZB@x_`x3OUksq2im)XVz z`j=`Sx|8hH1K`=<$fcka@4DMXs5~gj8BK#zB-xu;C>C_v)zqWv4p~R{32W+~njGHR zYs{)CPSraj%ePZUFk4{#PA}J#sn^72Am&mFuU3lZF)o!6D<*xsPa0k=a;ss|VdXtm zfH9P-?_lofleqO+cb95w7?D@G-cTj)eyQ*8t$r~VBWv<$*1+hM+ts`;&e|o?FJy|; zn(n*ZTxKA6jNb?=fD8v?gEpR7-1_T?6;1(|MZ$HMtmH7N@n5kN3G%0A+o&Bpl$9vG zay?H0KS^sRiqo!**{!AJj3519(jhp2>-i*r&>G0+?p}9w`<5JO{~$3Cl2BfD}S5SlHviTA@mq+OVkcKE`bMs2M(@2h1J+v2X%E!0x-`NNb;uhm!oZt7ZT%JEKkq>94!0m0#bnhk!x)AZ`F@~IVkqOKl^Wc z|NqIzZwTtu{^SDq*WBfAzW;mA|K8yL+tvT^5&v@?f1VHk#rmJ4{L>i!a~J=)@cyrI z7l4Q)3YTIHRE=!UKXukP;R>SALq&S6Lq_$*(4kMM`4;gNj0_CJ{_2Z#|8}Ts>a8q{a6a4$W{BtTFxR~zqdCv>%wQh)#uqYm& zxgolO_VsGTS_V|oQUyF^StLN<|L3;+*FUAe6ff_@J)a95byft1JwHADB@@C3MMQ6= z!_Azy#dF;%OLbGP`-}{+i;;5~zlxFGO0grur@ThYIJ2nP8N{)toRFc_URpq39LQCZ z1htJ=tO0%T9aeynJk^868h+8!OfbQA&Svo0zvsJWP^0tVWsX^LD? zfKc4>r!8y(AVixC)rOcfU!HMp@&lz1~%o&4_kL0{3z`;=z=i^2GJ`83yW&Yzz%*(PCa|@t`yPE`n{O| zKqia68>rk0G^wVVBnjEtXxmiPLq}aiQET7P$t-bsn4T}E9+1B<>HlFMKG&KuetAjG9?0%xJNwJN04MYOR_2ZUP~kWT5#mMP@MB* zyYqUr-Hqhz3ny|opQ%@`RBTYIWD)JEr|Tb z$^7dGy-KH$<7AK*m~amcE!!P|$|dU67z*sGd5 zrD}WtqZZqQp~u#|5GoEnbr#{aGEI&;gfgYQ8LHJ%1aVo9r#MZKA?nsSIFnWkX^g*z zV!JoP;%39o+JSlY-bR*q8!K%Cw-%%bFvrb@fUhQ)`j)R|1j}O77k8SJ`DVR^g`S`G zM^s*n(q&Wa{^X7Tw7>Yv?1+o}naQ}D^zUi38Y-^!CW3@H?GaV8-!~uugdC@5N3%Jj zgfd;_Yy6KKVxEJ&ie3d2hhol&_5kf!3m~UGJD5mjA{*zmrvGpC=8MAVO*tlpal217 zbG4jZpU=HAHt1gWrRTuY@J2|L-dTF=F3xs4Jg0}ucrH{}67&L4r*-9KxmSUnjFf_3 zzSVudw}FbV(pp$|A4zZL&JE@pOF&b))6+YMcvY!gzdP{Ia>YP}a7m2k19vJ;%61EN z{VM^Vpa~Nny;saKE_6JX=UP)AmNXu^K+?4R4P3p=SSWXY?wuWL@FoCKb%N-6l}Q`B z!}8|sDL%oSnzLe}BBT7?M>~sf=xdx)rY%NvecJxza)Nf4`1-3s@9yD8SU?IH5YLV zhepMe%y7{!`|H!ZXxD+u`05miR%7(U56)T0CUBCnVWq$<)B(Kfj9h$fy8}52Xfh`P zZYF7McqK!rv0?z|d_dk()4RF*lQ1h4KySfhw)Oq)%h%B|?AIJWd8I1PRy`71de0Q% zkAhyA`lMLWDYjH*>=lZPIAtJOiuO)R8Lt2aI+$3e6KVe|slM>63Q7#2Z?d>l5MnIU zkxUE050o8gjhYUY(U7Kwx@T~wu^Z2mCC+%1F4Wrd`LvX?)cAHZ4gy?i&Kj`f{7pEC z7F!6nbZ-t5V>te!{cfv$~9D3n`v^%ECeZ z8Qm#@ohj4SY9s80CACp&m3r}(cl1Z_g#LL+nJX~>{BYa11=Lr^GRYq9`Z4>iMRgWG z^f-rad*+&jF*2B|Y2p;v654bkx9wL`_*L4v@DG6rfXGYGc!0Yit|RFociJ0fbh7y* z*QQFhZl%@uR~wX80MhGRR*TG7qqZc(we#_Dn?|By+sTRv=qVB~M&NC^G~HH!9XhOJ zDIk9qV_`PHX2xQ78HC_{s30>wV&I{STBa_1WL9)N@0;I$Zq(n?abG``k7f7+9@~wk zIjYGJL!V8py*`<|%K-BuOup}A! zA2+M7Iz=8(IBw4t()9@qv0U8snQzZcG!2&=7qFv|9B6IXi@zc#5o%>fPIxo$epwG@ zC)X&0vr}v(!?&SJAA}kcUBU5RcF4Xp2}pKqn4CNBFR?LXe}ONiW0Ma6N{t}u-Pib0 zDRz=S0Xg`^5nU%Or>Pgy{F8pg7Z>A{{UG*7bAKsWyMcSzu2^@Fp5tYezt%VYFmudJ zUqGoc?o(KWsz`potw@!Qotr7ny;tPq%?gZt*b?NVl58x9>kfK|9_dV4_ZoBofKDic z(MdW(5m5_MCy^^7P}rr)GInaEaf?tCvjB$>s;ijHkbyBYKKqQaCJ7{rgZ+)ovRdm!)3Gm4yB@?;BuQFF>so@;xL`RK5b7Qz3fPb<^n(b-_UL z_syWDfDg0;#2Ar+lLep|!}Q+5jvvK6S0yiVvZlHFi=K61_!D)U?XSq)x>4|TA^p{T zJb9Vgp2u)0$cI?}gl+`CFn?jfdnz!C7lbgp{I;CRhkT`xV1V4z$B$hj#~h5csc3ls z0S4Q8JJj2nmq01v%5mW4%W3w^AuWWY8qp{R(cd)G=#qFV%=CwlUbCJ@4gJ?_j65;0 zk@GKSy@H|Cf?X5;t*3Nx=f)6la5DJ0ov${ND^(f5LtF~!#n%T*lm~OVzgmh;UXc@( zE3kilVeTlOG%UUQ*AUk;#2AVFER+)!fDlwVf8SvsHPBZgeby7WCBvUN?KR5;KBDZ& zx_z++>c1X|)EUM7R&jwXG#{5yl;7L6b@rZ32ai0ZC}4hh5z;Nc3zuk5as1rqk>Fw* z-)Uq0Y*g&%^b2H!-pA~a-u@O@Kco?bQi+BiG@RBrm1gf`ZCY1DD3@aG$tXC+-zD zRf;09jfvQ6Zonkm4FTkK!_jl|`3~Z>V^gw+fZtLFZW}tUdC|SEiY4Zo_gv=OM((O5L>qOvyx` znZv|Eof8r1@yljWE3ld3)PZB+{Bu51gW+LDqY4%A$5VM_qMSv<|7)AbO3 z+jv3@iP&aVW=8iDf-G*~*)inpE8INF-0{|^5a@7$UlS+Fu3Ye(J00Ftz0+jgvgTwMt|{}QOvU6E2O*ST;EJ5na@RvzAw$rv zN7fwlNc^~Zyu5iCT;qNa8?SV9=_u@wy{C;_qJsL%skgiKw^x_&*nd+;B&WZcCy~3r z;HSJt-+|+gEVwwIN_8kOLw*nB4O~|5IDJb1oPx8jG?js|HwNaptlP+T8@Mu=5kF6o zx2f6Fq3>t{(!6&c-X)p`=&Jas3_L?IYb!>B4{l(x){QMpnEpF!0Xo_OrKs`bN1k0e zLD<{XpC>7eRE;@W4?^o`LmtGrpX9f8vu5J%ZlZb{i4xMOj3NV*?FsSN=@A?fw}~G# zzR610Y~;6Hd8{W>MQK&=X8%Cgw98y)I_BB#w*|6b{|vv!Pw?bf8-P}fk@$g3@Jg#K z*CYhWluAlH)GNkClI<(Q)4LlPbL-1wpV}9v9+58sHhrHbJ30Olg#z4MfMq+D_SXiL zd!1B-!zE68L$)1iB=fMwIjT+4kkXdh;h+>0IUYNa{J~~5rqTnIB6cK#VYA-Z?JYkf z7e6U?I}43`ak+BVjuWLgy2+o|ej@@Io_c9B;hCSFT~lv8Zf;d+DoDF_b7Fks)AUGb zKhShhjHv4F2=EzL1fXT25xX?5H;ZhbYw?C|nHT`Vn-FNU2&?r2(P6THdiJ6R%GAk-I_EO)aG^&kpY}?=i2d_X zhX@9U<#^KI(+-7h$LZMaHu#KVT^EHS*A3CGt;!Wc$hOyVoliRr@)aRoKE4zU4?X^) zmSmuPDH6vN_^dlgsFd6%^X((Hhw>|`iI2KfG{(lbD$Mvb09@wn0K=ny{J~eoH!pgO zFdCA_0rcN>1IE8|HF?%4+*4s-5Y70zTE(B)ZX(68+bJbKe9MTX-C(*Frj)F$tmwFD z!dv^HLKagu_Ed!aAGZVmtPBz0M?dK08?@-*k=Ks5eA&x2jQn&%ilyDM>)DM6laHTB z{`o223HeutX-?hMS2YwJor?4X9v<8-(TlRC@_0dzWpdR~;vdiR8@^x=kUK|Ml^sM9 zQ{m;yiqD(f{>8!t41cEiT9KN5(4ms51n6+RgWpbvC_cWrXgrzQuT+C4u5evb%u2Fz zTl~SqAWHEo`y7wnh)~VCJCc7$?*i6Bp`eu&CnKXTn9u@sIVX>a=?Mt3BCbsS_bqw> zJpG0b29T$+*PrnI;qNc*-0KtmF266u2w+10`=kFe?;q#j z|I0@5^}CSV9qu)z`+t$#m6QH>R$#0Ct>A?1ikwz&4COC*87rc4^R zzR=H4s-y}kL5#-#sJ2~%pT1TXn!DUD+svyUs_9Q^THM$9Z{f*LHj=($zR;dFhJg#ulp&A z?HB)dJx?64g_SDUk@YX1`1e0Q>H-g>MWRjd-}&F~PNgCMu*D|3;?^&!sCZX2Nq`5k z`l68W@74ZNH2rvZVGD8dcEmq}lK;Kjzb07!$G%)MunNw!*lp`wT31z*3cuv3P&1by z{Ka4y)C)B*5ULy>8YdWfk4w8fMwIkdXE=t+7btuyCkwV-^I46iiOSvVpAoPvckMYZ znAz#VN+y0e^09fKoJ^a%f78oFz*bKvNc_9X#j(t0;G2&&>Q>D3Zm->^?i3Wn!t~ky zS=F1rG9-rwMOGY-SM=_Q9_^ie=E;GfE{kFd9b2(RssaH9ySgS(q3ff9_GFX8TxD`5 zG1P89wws(#29sM4kH}C*pBa*g^aO)H<5IC5`X{To;KUj42JAJv_MA_Y1G&o#{#CquA@QXOtRdh>;21~v-@cI@ zKF%F)t;B5)fgJ*uo8&&D_vQ!0EF6k)nJ;vgS6yy`Ux8fY@J#)L#$YZv-5QA4dRFqE}qHax^hvw6~V6Fn-)nR z!}ITtadW+psYURM6v23Vh|o(w+tzt>xLZ9GZH^HB)>D1>ML0SH;)8Yg8iF*P=&RwO zsoPu68LaJmn!Fpo7|^oLV`3*}&bhZ)GT4Fv(yPX*u;yu`J-WC$3*4>yxWaz2%Xt!M>v#WySfXkpHq&h`Gp(Ck2(jI& z+N%$5842yC?wm|as06p?j5DK8cHM^dMvgMQ9K6$Fwkx^gKZL<&J}E!Ih1Uy?Or5P) zfuWmq-9eBevd-k>G+f6NrlTs+WBgTiwi0gZ-ZRvQUwzEyh-M)n&hk_rQpqodLPkbJ z5{Y56Fw#MX&FnMF!~;p>tAo=3$wXG!^E*56rDBhlMat2ZY^nZ?LVEW-ZZ`oxe`V*h zmMr(0#7l~OXGvG!QRuy{Bi}6WZ^C++=FZ)CMCroVUd>$nvTvtRE{C64XU@KOp6v}? z^ASg*k)O;22vE^pl0mo3nS;WP%~IU+M0<4yycB-a z9_J}%Vm*6i7Q~qv`Hjv+SZa0RkEVqTB!<;GR_}h={(N)$G~(bI8?Csh!DinepfeS* zILKjy*!7WA78HKGm+f|ja!7O>GaJ6W96_u7aMHDRk#!bFH!N=Nv!j=DZJ%tTe8&-z zR-_{ktj%DC7Ox+DbbK1X4%x6D%(Py+YY6wt?&7eeP9`g?>Z(m$C@_}*IF_8kYfnif z-OG#Jp{=A7iyNb1!E|?Q1@hm}?{fhFhx<9t$lszUU)?7cJD1)I)b325Dn6w|3y}65 zHU3;uTH)q;4*Tv;UjvPETD@7~Ht7=NLz?;B?nu(LS#GHR3ry9OnYBm53m#IuEr#X! zdhWup>2w4Zo=CCi7UJ>QK;<>Bgt2n77_tO%i9OHg$5i=5tPMTL&OF<-5a=T&S9z*t zar7qGup6$hJeHbV#qUKv!7veq&MRQzK;N0xxnp=|OpxNryekVSxn^UGq~x{7W=u>E z8Lu%lopz@bY)JtHO zkGjxlVV$D9Q|a&@G+3ml@gQxu2k#kpY<`A)`06g~_GPe)opXoj+?L!MNrx)Ie-u{p zFa+mX_yakI=u;Z&(7p6q@w;OwCxW}n%j?B=^xDBsv5jXfCoJSLByC+7XvLb%Q zR#-*7x<{Oe8Hn)ffw9^~no9%pdh(vv2rH|d!)MJ&osboL*P0g&??$xfGBWZM0VTX6 zKJ(=?*?Dkd-^yoFr8E$V`~JdwC-F{|<|=|+dN`P9k3Z|u(YniTy`CX*w~Mzlh>PX>d*Uk<%Jj2@ zB7&Hmmb7NQV*51xj^7ozcgR~^#U#jA^8}IAk1g*EMSHn~c&4}MGTX7qPr02-!0wn& zmnW=PLs|`cA^xivhl=83yE{6r8)c?qPn&-N>O90HbCq7!;Ub1DFBwAb3Qup$Y!kxs z-^Q8bJF;8gv9I~3u8oeDLudLl56=&59y`yth~DOsA00fGLAq*2^4)_sB1g<@m!71& zSq#et*LuJmn(hgAJEM;>Cb=x#7TWcw1ABM?w!y8JT0BN~>orFBCahCWzv}M|Q4tzF ziIXb}a!LnGQpN6*u<0SOkYN#5mD*SV_~_+C+oCq=4R?@PFM0Y>vQNn0brn7?-#peK zmfLL}utm8u&Afwm6$=0)bXX^)=DL`IN9JwVtI)^t+zvXB*XB}$6TNVx2B@I7kSk4nx&)REz+ zQtFO{z|;%v2Lac5E2^v4hKiK-2qjR?IJ+^ml>v_gjAp83ITQax9 zzh(2=y9=*~QEPLcMX3Pta8v5#niEIm%oV=&`|>h;aCF}Yf&#R!N<=i|w z5|C&@cun+19Lkz%k=(qKKh-%oF*~hTEc*F(kruDDuf;jfqA^dxRZiUox-378QXEk6 zD;Iqn7&{-WVE%NR9szhku>u9fX0Jsf4rk5H;+w67W%%k*Zw}MAC%}>~@0oRb!qRCg zZ;G9f6|oZ|{J2%FifO4DMr+m>srE}OB#txe-7Z89jYok04| zK9(gFt{Z?WAYa})Yd&!+ur4l#C2ViYtJH)y-XFbMxyPGh{jDKB{SEUAMTx;v21#oQ zcY_Eg9IgA3E{8a@)4@$ImEdnBgpV#1$D>!}9B3^uy!})Me0i5PL7K(Hc;d{*V$K0>?J3jwd$VttT(u)tKAEqYrz57x=`2b8ZC2$(VMj@nx1u-;F%mCG3R z-*Nf+^SnMe{c+D!X|_&cm;5=pF>ju%V?t$HakW{#G0O~`8Ntlp*BiriyDkNXR1`yP zG~iAkB}Lk8HaIBl3;1Jfeu{NRnX2|%0L9Qn8_M9GiQ!6TKxUAKN=yt;p~|A3u3NcY zbD}C{16>jDl>UdnxWL~vnuetCabkFD4V^B%Ni+K9ImY*sQx9ELb^zTRz#uK6bv-pd z-_n};BpWw=8g%h74XE+5&wV<2{gHAoor~i%27oiX98erJ)w&%WvSD??FKcSXC&->T z$@HCy*fqSwV=p&(y>`+GU@-F#p+PR4DqV}E*sB2giw% z59DzkwUt?F%rMLPHRF3deC|N0QhT_W!e|eS^3iPIL|(wYQi4(r;d>2B9E}(nSL`TY z8+O&)@w-^V@@ByNSdKxpZx)y4RL}JY zd;Sssh|4l|nxA7NS6<(?pUTWfZ8b$;wWiRj6OZ`s89ZA#7u>dYYC?$e z^$=HqdrQn* z`viLub$umwtwcvwDoQIJS$Fz_#5=3N+ItGaS~Yr_OT@gL1{-ZrNW~!myfrTL z=z8LjPgiY#U2=us8TkyKwb4Xq(gTK;X`cxX*v=xSl1dsUv7>D{~ zTTx1;V`W&=Cw24a?x{RTf=z&SaSxuV)K*BcA8S+br~t~Lbv^5ri&gB`Kt?}3!`PPf z7)U)&78s_}T{t>E;_OGi_9H5a*EOt0e%bPVq2$U0e{M$S>ZRl=GU2_MflwZl4Yml2Rgj7rv=H?)#jU_EzK;Q#EiTIg2mBG-dR}UpQ{@&Um#mx+8K7CZ{l$IKxTyea%5zynJ zoo`G6iFL$A6Ho$xxXNoEKu6lliDw!oo&vd%=T&K?$|Fjq%|(39g||L@{XrrpKUjY>hH4OX z4$wlWG@K{$UL@tI6{-m5?&75<0RR13w_q3hH3#iyK{tDTJ6yK}#n!>HX#7nGv%;H_ z&B&;Q?kkOa!xTi~?vqX@iFy=6Ctf=YR?nH_1fKEU$V+6szswAQGhd|&PiblZL)X58 zbH9<^C{zLB?7I;kSReM1?>=PaEaB7l9Lj+N985l~Qv`N%cNkSXj=Twxz+bMESd4rF zXvkGwg?t$NInwvgRsW3gk=eb!RU3h@2oTzeF%<=>b6Ncv?Y^#L zoA&2r0CHW`{qg>C+i|wNeXG?-e+Iv~HE%?BS@%7NODnh?S!ol!nxr^n)KzY!Ju6VI z4I*|piu@kvG8Lk!pxXSAS(CfA?SB8Kq||Vj|MO}};-<@tnJE8ppHEJ`D#a#q8|^Tx0{9hwXwB=^&e^AHwYF87tom^@-N{4z z+Y@u|%c25FfPGk&H=eD!#V1)xW47HHTa**kw9&8X#nJ20FT4~G4H)DDnn;J`L28wJo!;&_sjm1r)!D&&i&7jEVJL*0yL&J{I?Bjlk=-y z(z0k#kYrV-2NT)UsqbHVo>=Cy_-_4^qG2$^(iuBdR)!zdqe>xdFrjPc=p67Nvnl+) z(hnB^xztrF20R)I1{8U#N65OWQp1neB=wWG{Ctl7sO>TS!0N-M;lV=EdSQ}iQ;f|)ZRM0(_rQ$TmUEtZj4#X_RUadkj zhJt5EBjT82>y~=#A?>P^|e2eV><~j?8eXtfWNtR+!b?y=SwcYOW zehzM=s{m+sl9JVXEyV|lxwYE?wSzsvO5`P*zr!097lLqa?{gCY zMV%~Wb!OOQPWKaFH{52km`wrQ1V4kWRzozSoD3zuDQ|AlOV;ldEDzajW*WraiZEMZ z3XXJ$w!p}*AUlJeXCx5_O9DiJVNh8R(6=QgVizyi z(?BF?ElOmgB~{zLycuy%q^O~1vb1-PLkGmONdfAEy^X%_o9+_P{5IVNAWzw8?>`iq z{=}Z7Hh*_V`hYu9*Ny`EG+R{>lY;TqNee`6R1uU$GUYv=deWo)Juy%#gSh81+iiuw^+(WejCfmb|Glf<$`iH>GZ`{06J(@V~sIeTdF9Vvp>jyaM~Vo@61 zf0yH`(<;KlrivwXW9i4=aOHeVi@vJ5z=|^ttKK;Hc3kW4`KSV1V63TfF4)}THl>#1 z2~cL23q0MN50HEaZ`duGjD^?e2g@#B25BJf&BqDvzI{ji-Q|6SCg$g)yjx~xe0=J2 zNv>;vBmR6V+~>A+`@%{~k@ZWH?X%I|QY5<{pc~5qW~@22a(lWm+(l%h+Q$CQ1R%~% zw)bxU!k_`0N?FBc|J8eg!^f{skaCB$sX*FU)}OW99vvqE6?$WUxW{`%(LwU`yI4WP zu^>)>$vRZ$@^(x`uWgq6V9Pu8-e^7R;UF*7C~o%xfJrrt+XGe-_#KUoShZ^HHX%ff>8c9?yisCX^B^M6+$pY4oaCJ3{AKnOocS1bRzqKe% zuo6vCJRT)Adl^ZjAPuvPe-&+!pn~p#zswb()ktFISdrk4Weh zSymbx(Q`h+d6VR8%tLba0z_(^7r4HCO?N6I7zhcBmprV&IDEYZw<;e3rCXf$(Q22f zlsj2K_R*g@>f_VG5H^QZ8PGeLb|vJ~ES)u8cLD&$$iHHjE;sTb0pOG4?P6V`31Z<~ zz#%8m{Mi-JM!WHHZ^uQ-=K`i9_8R9O&O4KGif)m{p~A|}jK$ca0yC7VR>DzF!r#(Z z>a+^X>>*DMPz^qTd`0m#YAmCDUe+I`2s)*u`NOzPx!-Uk*>VMKoJI1nK7@W98qbk# z5X*_>zPDmC9voL8X1q=hnJ*s)GVK!xJEya5yf%q=HFnhLqvNO-ufa1L7=M}UNs9#4 zd|fq6qM`QIZS)A(Iepfmkwjr5O75=srONAZZ;&|$Ufcwo_vR;@c* zBBu9HTS4P0%grLc69)eWRH+EQ0E{_Qw=M%$u+$3zpt{2il9|nbRMM7F3vXyOFK<0Y znaXpm2Gu@P`O7#lutLxUIz=h*`%l$8uC%pALEd&z6-#(KG5NgsdnWy37HEZ8o7I|` z;=X7Uc#7{>K7-o|rwFIFqisr?DDs+jAp7h4{0+Y%{^EOa>up^Ki%Llo2;BQonCTNL zzEW*4!q>W0epzPJWbM<iHQl;?@evOEi-J$c@uJRNvpv63L(57p&sa~- zNcG->&S(6?*$VIFuK&jjzz2!||ES3s9Gm?1SBSk9AcvX1{xXWZtLz zCI7X~$Mp-uo>o!)mkU=!0pGfaOWTh4ug~)5I-0ZqVqah?ukhy&{%WO<+Q1!N5ZltB z{C9!fKYrJ@;6eu##wCCCR|^ka%*9ufy{uvX+d=x*nNouR4^$Aw!v4#Jb>#tDXy4`( zCj48D_ph&309>f*!==nDzg(CT7#1JyFj>m^E2R17CYBn$m~|J6%Od#I!d5JREp)-i zDav2I12N!%v|6KL{=Kl2{1v5Sp=r;Hxths`rrq=?Nb+)byukm%-dlLJ`E_Za#T|lE zAOtOKai_Sum*NyF?iQTjQd*=GcZcHc!Ao&1?(Xh-)8BW$nYlBaKj5x4YrQM$4M{lf z*+=%XpR)y6KR3wO_-W#`unFX*kJEB|h7(rLh4ywm``<#I^!}p@lG#l18+WI?2A3hv zwtJIBCXw&XD66#=n>^%Y9m}Cl+%RuDz3MBS;uKh!fjFM0w#SviC}EEBmMe{*)o6rk z?xEzzX0mKpM$YWpyA(FFaH+3@xS>ba_7H)mxNBwLSve!vuIUB*51J2}Zx5QzvCTFK z=LsFaLs6c+i#SPt{Op-@7)`Mk+(xV#v+Uc*tjk)q%s6`MO!c(7%Tk@jV{ngC?3<^( zPsZrSvS@G?mrLr8beMI%>Ok4om^iF1%vIB)YHeFQFZVupJkcwpemZKpjwxhn47A0s ztGDf%Bk9i)yxxb^FkM2Sh≪!cuC&!pn%icy5(wZ-qQB5~kI6cv`2}*6pb{kp7cg z;|2UK+T>d}S*!>YkjGo+>rnEBgjx5TOZIt3hCdFj1*wjrE*7O+nq0lW--66@V)HzI zQWDMwg^yioSk$-Jk~2X^%hI;QaD?x^c$u4Xi7V2YMZ2FKqVWpRGl2c60hPM#bY)@;oDl6??umMWpdJRc#8lnMPcH{H3#H+KP71In^}4)t8`3>ia?m~;-I985d%f6M)!I`h8;HO} zx~uo^TmUa;;*n^*+1gAd10&CO3(_r=1fCLAwg{rdDhYmk)zt;66|S5cV<5tz%cN+C z+?^IAZ5`cHIGSdu^_*?}7+_)j;8tv-QU1~7Gtp4>=*#)9m1-4_cdSYg^^~V*_)E(2};9RGBmRdVxvXBK(pCIta}M( z*%2U_f1Js`=5T$yIQD%m@6!T!wxZVc={03v+H6%DL3ADCbAZcLX({#_nS;dXPEkMD zF&*KbbovPAce=;Toi0b(Lo}f$jQULr1hXFW?_0Dg;dM`5Q*ItjsfzRisK+~cxVJoLE+`+|HE?_!-_yffKieE;KB5;2%5;Q46trRX>IMx2+2ZD^FzL81sx4SLjHfE|xsm-y&dVYA zW7WvfF`mi5=%eQ*Q+=yv?V>`g32Bq5rGp`o_)LHN8{7P6-U)^0U2_ieqvK)o_q9Jh z4315O8}*=XF0zF`!Gf%M748lgcrF|^`+w)lZOX-46HXL%80AX@*&`(GD<=!|(0O&d zE8xdh3Ys51P^*&2p6ETizq+?H>*o=Z4 z0@c%gKY<-8(OwIjZivzSDGWg+gPu@>3QdrA+({2amL@j_*V}wU;{EnG8b1Ql1rv;wU*zZRtF7}sU-^QptkjnUFC3oV z@eST_-S2K|Z=vwd1J3-MH0p<;TYh}^NT$d_%=wD-*BwXF9xMjXFSFJof(t$~Z2l%b z3xR!8Z9kPcd@HXFW6tCJ&uZ!g>#~MSW)37(U4NxEwrPi+$1ZUFt{=JazuXV{2;$yj z*DpWvMUE7iKpSAYAIF&(V!VGCsU4vTG4~tjK$+sY#4bF12$skz7y$021Hm&(ixJ6F zC}a(<80ueZg65kX&3qS8p}g0kSDved#8A1;PQ(GTI#czjGr?Am_g)!W$>pW7zIwf| zoys1&*7aj`{#O(1pm%*-ezDu+ zu-F6{viksb9f4JqJ;dJ)9HO&$hFM+jl%Ds_3v`I@dm((M7#xr%F@%D;<_|>&{Y$H% z6c%c@(X25&Jj;sJt~cdnksO^ifxJeL_9FO^%{q+p8P{}LGDb7M(Z zUOEe{=y=1i$J3&0Hs|%glCFHu-0e)hc`<9=^lq3mmg%g?A= zw@`aN`Xn?LFZ=!7od|l)fGunXqph$+wZVrU$DB`Ufd!e9Q@JFTwH$c!ko85?;fIYD zEe@5f?`yO`RMUikSi4joGUJVTz$SFL?V;aFunD1?3_%M!gq|cbb-2+4YOX{IaXxiiJve@SZ zjPj;KdLCP2B};IsZagxI#@rG(&EwbbLBLNlE#Cbvu?VYu%Q&hps+Y4)0Yt1`OWIQ& zril%C=cBbI^3L~*CYYoQz9OWWdf;^Yod+M){RT5sa#gtOkHxxWXkcr&BHQA9tOtgm zIDB65w$)^LeFR=!EhfXeO@HxYaHPiXEkj%}9J5w&?E%^r+efR`tF8Mi4{=Y!-%GxY zSNw099Nli|wv$In9Ee>^5>kFLdc|+xaFRjuefCeiMdp`b!HfL$ zPG4m!f-(<7RjEwB77{lA2dHec-?u(x5agLi} zwq4DWyrg%5m_6&eH;`O(n_da9Qd7gleQEJi#BX!K3~`oxM{}(miY8-h6zcNe#~!YY6uKxhcbJWDn*o@X^+S}Qyhf}; zgOgQO_8P#_Y+w-sSW#4d0!}_OQ~q8z06UkH*MZq(BSuqC zc~hUE={(c1KwC20Or(k}S`b?*a~4-EfXhIcn&W+2#cZW-y$Oo}v!pdPugsQAv+%br zvN;AqJ0rM~4vwdb#Yf>B(B>dJepnPjZ!7pZuhi-k48bqGAAbvYfo%_=76X+<4`LUm z{M!{j0$eFl!_n$Od4VauKTod}Jj)+ao+M}CI%8;fp z_M3$d1xJCTMJBXxX~ImDMvy3I7rcM1*Y>;^|3~+b69wuO3QXWA(@~NuzxY#!+8*Xb)+LUxo4!7PO4#64By&vuM{*iyo3->jQg@ep0cmaW_;R|Y(%nNslI1H zSU({ItLSQ9Y?3GO2zVLQf)V{#t)nHnq{F@!tq7$9K0h=>6;1WHFN<(K59uK7ypWd+ zgHx;j)eP_G4Tr|@G5cYk-H#o?8W8q_8u5OuRmfn{iQCmcJ=wFl3}ni`SC<{1)gr6{ z#dYv`J#SQ9v3rHSwnoAl-Gn(0Fk}myHKoh6Db;S~u3B{HHbOxG8C`fyWV{ehm&|3b zC7gsbAL(?olWId~#enmbhl<~VS9pF`X-%>Fkrd9$$slTcZ@t6D*#p{$e|-Dl$BG2a z8<1K&%aF{-JCnNFeknhh$)?TPI*Rh6sZ-?ywAIfKA+_5M-o0T_m5D~U z8XR` zeIFyy&VDzE+xKF#nAv9Kl9BV?w0pV^N^WNu1(#(rGjS40>ArIIeOxR(whkR#G?qjH z8VXW(t&eIq&3^XXagez&>@3&{cC>H!z`Ab|O1oF&`6ysmIDoWW=a6Pk9wapYoT64F zCGG{z|4NC}HSRb= zd_UT+^5*+-K?d12v|%l?@TXUFX1yQFeQT*J+0h&LkSwD_EK)aEwnP8W4D=EZv%oRt z#L2G~Dx8^eGB>SIkr&0>s9311K*-5hWyk5va$Z-dUB*L~re!6dyUx12>GjXIm}w*Y z(t-r6eCHQtQaJdSUXeAmlNlNZBz$Mk#7LA7qIMnBY^2ENqx)U6K^kTGc)eZ(QyjRo zmGs9Dlr&mYx&{=01D(bG3xPJxdF@Erorhc3u&1|}a42GtAj8vFQ@#zt6)o~y0uM9Q zR|D?pA7~_;v<_s`0?aF)SNH?(Fs3|rNGMm5rL~LYaKly03~z&|f>Et)3oa_@Gu*mt zDWhtzC?_`L4xsS;s9$iGTxmnb{0ZS4YdIPJ z+2k;jdDQVZBnho9jbKyQhOj`l$_O`)`sGJBTn{RwC+AU@=cp_TLAg&I+y){6T#Ss* zfRlxf?i71xEjaW$H_O&cAM#SI>W=&npQ}pm@n{dhSw}%4jE8}I_s8oJLY2e*?GDEX zQAqK@yss5RIsx;zZcCulqd5i^CvoY`cT$h<=5*Y{4RK$M%QwTNJzU{d*Y91MQNy9V z6qSCO$%(>Dp9bYWekvVI$2`ihr%Q^ca$ipDJ*?QsAV+Zs_<&P#tAetk?S5P9HrNcy zIeDdyM4Mpo)aGJt)MW&SJXwl$gYVxwXKA$)y4!G0c)QmcBkqaZQsLv{(wU+c&8EZ>?e0?-x%+vC8#7#$af~BWv-V{#nsWI@EjR&+xVS1UjrtXg z*3^MJMI|PH%A!jeE>eCQ_D<-$Eg>!V<(i2MF{3MB z^qr{m^~4CY0$LuQ!p&5U(Jezv^$hCg?5|r!o4h?oq8%cNNBflkLdI#MuUHwSjsmgR zw0cm%J<}@u-d) zkP&advBU2t&ynDY%`=Qd7g4ER22>#~c6`R02Jpbv)-ds9O2ow}8(gPAKYTa7iw)ak zVRNf5Zk4KX#}5g3MuOF5W%zU^+(=V0U+J&DoB)g3n{T#IXI0_|d(g%NaYiMU=rlxY zdfLx5jPZTJP4A#Y}7JfhNR#QQG#yZfLlQD`wNS}@UE*BcjuScBw3;<6}0P0O*z?S2LOA+EyG zwJ87YYc_pUy4pWg?_c}z!Meo0zvUWnX&RuH8~M?Af04o`r0INxly5!?;9h@kRPva3 z7JgYBT+xU~yMf!K^k|NMjJ3eOpu2%IwZW&vyk9SIV3_v>2MN{pzSFkmnY9DcTfGxR z5yBqr7!hJX^o+p9& z(LR+qq&}}A&jVbZDvs)nD!%$7%KSmB^@!-OT-^Lq(3NZh1=S}%JlCgBg~WV_M&cbC z8ap9zN3=UNU8IptEl+VFly$e$IqP&fA(t;o$^j=mCAtOiq8I#9f;*{{G{O~c+gaIN z$fakp?8Xx(zKXU@6p)dt0+CZOp$4BwFc6V;Q57T|9Ta7Bu4ONV^geYl0kTeEtWdJ_C-hVZ~v;)^e8xo{afR$gd(e{0_ZT&7_ITvum^seVjE z`T$hSbf^GXA%sbJvB|d3%kyYieawM2xZ5c>hwl;BAGAcI$>R9{=D0AJMJmv(}kW~>z zQ!=gy5^bH3h-=*AKnKz^ga_u}^TX2Ajb<`$jLyGlS~5^&q%EAbsb;@1!POvGd?IU{hYlSqH}+qOu3&bfien>Oxh zfgYberE;Y8KneE}4vT+!9<0Y=y&1vx!t$akv@m)#Ku2V*VpVve?0q^va*ZMitWxZq z5z6j<9Rd<9z=-k>^QSHQ#+f22^$taShvh=y+$Kf%2kDFb?n}O&j{Xif zpeM z{F8U@KJR@pA|Yq=craNEd4Rl!-ooJjMjmJjQ@6M0-D(#i{0#Md@XO8Bl;eD4)s+HN z4mRqYhhQ`r112t-KOV?E`CO%pxzNiKxQH}Rh3Em_$%;fg{Ld~c;{bMWYD*!4_wqr1_+@nDf-wHEVO}|n7gYp zh9~zMf7J^?Ub$8>PaDA}nPm#g?YPmdSx{l@19GA%7#%-ZaMo>8=f1zDJUybn)2R(AaY;3iVGpw3`V$AgpAxoYOF_BI$Mn((iNs_Wq zSt>vcpXhS@V2`xlUKINf| zH#X~=FVBDKf)IUqJ0Iv_cKyZlhqRAXu*7nVZx1CbWyArFRk+bL285McBJ21{Jh-fw z=j6`WxB3&{A}@DdNnX)?utvh6*n~_IEuEimNWUAEalZDO& z43u>Ip;{O>@L#oLB{ykoyt2z5jZQ0V%PwUvW74dEP`{eC7sAktw!)ujkOhn>P&W$r zvpymdWrxdCPr|axd~7)PiTR5R6V#I)zn8NBHIK+~*!oA!$tvplmN&3)f;xB-m{g4y z?1D(^LOH*AZ*m@*ENhOsjhDqU=JDtQWua~bZ6e0QCvqu~K2#a>r$O3GA=w6p3Dj1< zf`p*@+fb$M-ss;{2u;Y%xq)#zvwf0+)1|$fTV9A9cDoRV$u8|Q5>yF3oX#hkje7HBn2M%_F-Qh_AkA6+H8l}lc zKtH!1Pb6Ut?v86g00?`3`L{Xjl z`9x1sU1W|QfmGQ1zm;i?A8kB)5%p;(&T2#9aM9JfXsf%hf+6>uai#C+oQSyeWN@+= zqQ(JC2L83CF^N4nS&@!UcM&>T1tO&6zYJc%kDu^Mp;QM@epT;suqI-8qEj0Z7X?Jy z+2RY6GrYvVDUs!*Yk@qZ*hle{x8A0=&6ei)Yu8$BuB6Mni~gnhm4B9{O%)ywQLl11 z;!OONrA0BiZDm5gb1wf8G%hN)oGBWnK(HKmIeHr({I-#NHHnz-7-ocR4C~v+?BCu7 zBH=M|1LihHf^tHy51U6mA{#7mpq-eWpIO_dj0k1m-H?s%iqr%cmH>atH_Bg`Y8KE8 zG}(PIW^z1bm{NkOeE;m1JCZk{P*<|QD&gpyCd8=6=SoJhfbt!P8faXaf1bTBCOD|s z8?G}f3BA0{8OE>E-!pz08N@r6O?g1F=y8EW+Z`H)Sb6Ki?;mjUzca-{HUI51Zn_l+p|*B09{~l>f_a=IP_)pOue+)}?mRDNpzP zwJP-q3SJyI+a;GOjCU4QhWBHLL-;ZY?!pBt?zTP4az@k9(t+|(0g;w1 z_~)quiGFtX&!3oel1P|wqBKZUzXb?jc@snGI{0#iY^SC4eFv}7z;kaBk(kV+fAvr9 zax5@PRbfOn;RrTBI}}V3nPm9tjH%+RVbkhc_(KUL#Iue>YpC5AjVf+i21b&79eNFi zCayQu5&I${Acu^?j@9<23_Qi|NXl$rgv+82C#ze-#k&UJai%gW6Qw7ovhg&jr}+w5 zL6k1y@O|o8ftsMZ0Bd5+^p9#jL`Q;ZG51S8K1ww#HZh|`;233^&QsVW*cZio_WK^; z$;)U^#WcNZy}jmy4cT*@E!*!**VipDHH!VS`pwmdt)J-=eekOJrGhn=-A7t3hu!P> z6-35+JKnIqa`G#@PjkJBbYkkLKZ`zuos>-Z7+LPwo?(j8DsW<|3nRcnH(nZtNb$Z? zqWjMD{*@Uow1(^?WYCPLPJuDnNt+0N)1U#fn#0Z*+-oZ;(vQTyO5FyiG@qfGb`OEp zc9r$`^Is(}=+50WSkbEn))6$A8~f9`qDCHD0Gs!t2s&iXh)-}a0+``L1}TiqMS{GhKCk)M3}ig~tD-ai zVolJW#jm?ELQ2*9>i(-7|Cr-AKqA!!mc@&xMEJ;S#nH`5;rc7f1u8}fPAU}4XBQMP zEZp@@LIRo-BAfSiX=k{OqBEcA!+4V7pegIK!4HqusPNx5a1-KxMTJ10T;hB7FnbNr z7h+Sm!}-at$;9zbQebm{2OFmr>*s)N7u#D42BZ!ATS=MCcl}Z#odmznY%;UZizM(aV{*gf#O|DZxzNY%wz_TA zn{Q_}*wR0@&mrm06yV14hkrwvC61Os?M_AA?v$T<_)7xmk*@3bgmy1=Z@2bwHuj>C z73r3GKf1v#%?H66=|K5=ozO=Xd2zseCm)c{uF6y}gxuiS)Z)d@AN$%Gxh4@=%;T%! zRYYT0$Zfbk&hhCev)G)s1#ub+jj%)Muy`MQN3bntip{VPtY3O>#zk9EasBg`#sjTW^;AX%#tJ;uwwwA#}}Cs!}~Y#|DvB!8vLh zo671Hsh}?Yn&p0r`dO&S3L>#mHLl^E@PI%t^RYuJ9O@<_p1<*}(wPyGwO z4nOg4-@F=0ne5e%EML63u)}Z0^1P}Er#6TJp?hZcb z;xxz7-y}p_II`SfHVB@i1+QwD_J8M2yu^cZWngSqQI;7s7{bSr52m@BE>7EzL_AO!j_%t#8+^Hv3u& zIM|N7ezZUe4`KYIdmT*svKnoKC1jDR-SYHyJC&l^K%*wm!azifzEOPIx2)99df)u< z`In0AyN|xBHZ2mTYsg*tk9{J!i!Z1QopmXxAZkR8PZII3Rc+}W(>tQu%YeE+Th1M^ z5pN2*CXY~O(P3&~_)d=5fJcJ*78sko$_w6?0sA z6h7@rnAWyP0Tz&jy+5^EH+mnk>S_^1C6Y^SMPC!ctxr9LaL5>S21na3=N4G&bO>Ws zMxl9r8?5J`e;i%Z;E~is#?z<=xe@8}`U1kx!V1iB@6@bbPk7#Vd+$1V&|+$ZbCf_XQGUxg*L=C1M>R_c#LQk{Cb zRlgsfM{Wh>cK9E{I4sufV;CQyeR?g-Y^f!fg>Z;+$nlfMK#2>-X(TqB|EaMu(um*@ zWt+>L^*frlK&RM`v=x|Q@^u|Ol@JL;*D!~^ur$slRtz006r7Qp!eR)w&lC^O zL$YZ3Rvs!g{FkxNU{9y>E8gX#cptM>aQ4hRwxD4*0vAVI;8fsFua+0A5fQ5xYeLra z>9J+O#>b@n_&au!QPl9^%9DP;1^xW}t(LDe_K2qPzHq6_Q_bMF5DNCNs>NyaX+RZS z?mx42;5OUWIR?5_!c@wNK!r$&2(h5s>$Ll^?%XdsB{m9v;o5#aJE3&W43ckR*!Q0Ak9;}#`ZtkkJ=agmH zvWq{i18EmyB zszp>=-xZdZ8alLB@7|}z@u|DDLz?+}wL+=|ic*6u#avy}(qti&AJB`ae{E|8_eK}2 zlZ$gt;Iy}ijU0_SmCcLMRimoH5gXzkR2p;#g6~PJh>i(Y^Y27dGj?z#zoII0;~Vz!f`8)i$vuIP7v_Ra7&jLiH= zvn82h)uOw^3RT0qe>@*DlgMOit`y?Y4>~uj~Cfh z(I~3n68n>y52=A3=GoyYq!$gkX^URr8GJt^&JB+@T-sBQP|~HQ<$hqkx=lR2{WS!!79Tspf^|HElrt<_#;Z2lZ$cWz(FikRWK6)eLNi6Ivf@Ray<|$@) zq-~HJ*hYOa`7{H#vIfa$J>R8(1_Prad$KWJyIB~P*9Xk3Xw>z&x{v29!B+pkfPXKl z3rFzRfqCgC74y|rjC}-PjbG5=TryTK$n-I)qn^my*5|q_YKvk1Hr5H%5s8C64-a;f zq4qA6s8_Y16a6IzK2hxm!jh437OiEl;IVro)fZHHRtvB(e&AKN@qpo6lyEbj%sB7S zjMUa3QKit!dRPN3rn*F@>4CNJh^NyiMtIcJ4?P`oQerSrf5ji{xj$oaR^oel`r=q7 zNFqBV71Y*P0UO)diU}w}4AGpLs};-vfvMskFq%a}AP@Y;=mpck=G(avtYfJfQ91U`@X_jJ^~~+~&ow|#Y3U5syE+kFOl$v!2}ioB?}_O&HY!76 zWv<#OjkU|@elcJ98S#kVIwLONac8;ebYzi&KJPX1mehSvzlJDaeh*_Min^Q3PG zUyeXpVatDs#vRP1Vp_n-3#*p_gLmd5x4-YcH-aM20*|ZFV_=iL4*nb1i81Md-?0cB zfR834qYJT&bq;=9vhdM9v?mKKLjK+{h9eYH@nGzZ<^7e?uFQv0R%k5dr>4v<<^cFH z0-Jy=P+bo|wMkn4?!_{$N_m4UZV5qb>OE}G@K zuIrC|ASiL1l+V5aEHrC`i+{_ljFw_g>c)PII__YijW~6_)AjWQH)Fxw0i_-HC2OQI zQI)L0^t2I?&CLscY-;#^K!|5niTtQosLeU#RId{q4?YNcc0+f(FP~Y8)L?EF2~=5) z`3n8S@)h>F4;9W`_||=;gNcwGSXI#n^?-8TSqe zMSh6ILYN7WxH$)wI!oTQ>k%A#;EDV?k}NwTtZkvEmq8zM8ENJnc}|s z1=U=9vHVu|tUEQOug_P5`RXY8u}|yS(&q-N?ffb6p02l_B}6)^TD%*^@yZrNJsR1{ z*_i*KLgDaa(nS36qge^LLwKli*H!ROO@C-HF1s(99$9<6O?&T+ZvsldKI7};JI1p1 z+gFOFSgU8tYoUX=WHOP#xYL~Vi|otFfR`U0{L0HKEKtwGW2`7(1afpil+f)0x55%S zDT`sD`GRaMek$y+u~8`PBJc21E6CfniyQ5P*!8YRaXqBI?@6M~A~o9)DF)qC4J9l* zVOD7t=FF7ZP+f#bn~EcWvAWb4Sx2)qtc_SW7 zD=3&NHv&&{ZxnOhJwqJe#WX**8=8@E3U)8T>={rO2~e5NvWCdcwQq+Df1;mBT7zc< zvg)BwCxcjPu#_yj8szjaQzW-PK4kQP!`8kYA|e4Kv*EopJL)G8t^2kTn6$~cYCV45mX`>rzH?kSU93;I4%A-_5_1!M%w$j{$IggcZ zy0PNA5rOQng&S0H%bOY!q$U}5Ha%Tco; z)8O8LlFhHe5At(ruX&O%jqtH=dI0ZQmb;e3Q9xSLsjffYWF0rDYnc=>Jn-ILB1lv^ zAD+A3WWn-vUA5|gRh0D{j-();3K3Wv;Yz}c{C`7-6!R5!wWyYWzaW1QfC&5>{MQcf zYWBXZR)<**b~s@OKU52C21(r zYaCA&BzB(utkg9{5YMb{_f&Zsh;Ni=X5arJbe06_Z}hGCKy4f=v@bX2U>kSS@+m;l z4Eneh#nMPZT2WNqGlDRsS^jaopUc;6#u4Rxk(h^Dnvr9Dcb(~g<_1>)Q~8f6(zgj; z6?vbNz`h*Z!;vd^Hr}I3AT6qzB8k@!9U+b za=GDsKm6ACF;2Zii)z^1F#Ev-#OQg#>^IXQ-}lYTjh}YBzD_n?YUXK3^?G$3Z%-qv z8+MujOI0!Iq0H0HjvPQLfgKh@GWQjhZk#F3E;)tYx6Tyz8pAe2vX0S^my!{ZlNw>} zY+G1=q7k&{ZACjhLSIqxl1xt4#)0^{3u7U?`RKO{O0hV@aIGTiVX=qI+0%vL6$}vcc7TwM*{i3Uf z)drIa2w|QlNBs!+V}ShUCE`yb0$0?&$ZnR1D3eKv*PgJt^eElLQeE+bL?F{zse}QY z8e{7p!}`zv{@0bcf}825esc8ESpl9_MFiE5x4&=5-&%!M~wv9Pwb5x)POZ##{>_8@XZdXg%r>A48L&Rzzt1&1vaaORib{XbG>%w`qxDMkJscENVJN9 z1OM^b?5AVDQ3V^X3gU8qa?pxRuBg3utczx3;$4syaolZ^b2OW1#O_`lq&p{j^{7VpIRd)GwZ|8Lm; zZ`l9m-1xuM{(r0eFWcGwZSwy=-Q-3538FPhbj(BAPFkVZ^$T}j`0`!CsU7DV|2LIN z>HLRzO>RB`O|(q&J8C{EJ;x4~nSSoE-42;Vd$>06UO23aSpLcMKQ|B9UxGtn8n@HA z{C(4S)(FI$0s=8pSlCZKw6=R!3LfMx`)@k#UvCL0V44tpq*ZBGt_v~uJgUgDDcwLg zZ~bNXzv0w>(Q7h>^DwsHLN=&w1%PyE)Bc^_{_c?`bXPPA}r;&4EA-x3#qYuUFlTl-($ z+`p+G818V)cy1WQgq(&N>JuUBdxRA=?lV`BK8Qs(S#3z0T{dBLa5JXPW;Qjh%m|v) ziL&0g%)y_J=Qf({E#z(0OFlO|(tSR%xSB2fZVBEw+R6! z05F5*;Fp#oR7kz<^X~QLR*$lIN*@PN(lV1tm>??G+c-{?;}1)zvlSsl2Gx4GH|qvC zk%t~*{zslizNX0@10Q2^XAhzmhlD=JH+qG+lrl(+~rAN`Fa_6 zN6(h)>>8$F{B_1uBGzfc?d}^8r3{2XNSteXCrb|y!<|ul4T;LN@T-+ID3>tXwj3rZ zz;yMNxBaeLg;(W$M=SM<+O9*Uy~n_k0eHl;h)|{I-z(QpT~cIAV;aQxc`0Rffd02& zDovnSG7yjDZo%QYK*?{sSNQj;Ry|gLygKh@#iC+)1U9>5giVdy54Ur9)iIMg@i0>1 zosC4>;^{ITpNyxumb2S(w)rj%(gV#t5pM=vryLpj)6TN(^b}Iwf+hR{mS~G3;%xQp z^Szhk>!I7t6y{diaKkuJt=H8ruR5=v%+60o-zyfa@xxZnUlFvw0DQ2V2%q=zXR|cm zFjvoK`EYoNTpmvzE>k%o$1$Dd=OmBg6k!wWcO@D~=Z3{O#&t%U(CLB{ua7Ad)xcdJ z&JBXj$rd+26svf|bKsdgS!^tH!yPY3U2mn@i|+1~l*8Xb z(OdaAi;^fGHP7(MwnWc)n;x0SlrPm`#ctS2-hTbB_+5n2UyP2j=cDHum*DwKGq_MU zg)O5Oc+yw#eu%lpm`QUO#JQw!?`o;A5J7ru$(N=(VjF0XiGdu&L!uOC=iX#u^1i@x zNrj!9>{UZ<>{g0Ta`Iw7v0Lb;x0IKjPM zy62NO2FAlU3nmoepv#=3O|1PQ9oFXZM(Qw+ z0$r#uVUF>&Tr&6)Y-8-)+_C z)UkEe$Pt7E?|!$sD<4oW*kArdoE<5cS=G27LPIwj1dmq|ceU7Bb6!kf8Z-G^6*y!m zt?srvl-$<&VEz~`Y*Cu?^pxzaZn z%wpnO>zfwxaNOKrE!xtdNnxc_=bKJTixG0R%TRv+VEx|=cpL9_Eo3;m2X3$d% zE$)L7`O-rBnSAGs{dQ73_*W)K2;`wNs3HUr{wE0RzwLK^h+p2gz~gz7i3ZKSf#g?X zX>je{j1muvRvS>h`f71x_Rx8C6a_K;sck;Zmui|Oc3p*?NY`TJ^Ws)1nN4rM)K_un z>UJU|ZR%d1!@OhJDeV5x)7J+ff*z=$74fqB(ud2(@DV3&#O(}7*YKq>UXY}W9xhb<&}bipXFWGb6H_gZiyqw8|-AnRP7dS#_@EDzyC*8dvc1HA3j-Oo*Qs z+_DN@b{R_7m`;W&Jqi5l)62mv^%!KKa@uy$>uS)@w-49zYrppLkMmG^ zZPwBMW_XGS_>0j~3eFeFE_|7o3Y7VGE&$z=W#?hP>-C+MnM3z#&A67NDWN33Gt05<*2Kq(ZyhSUxQQ3TtPr_GIK`6mPDJ7x zOuT*aG>v8y`sSqB3+}-a?u)&yi~JhITx45=ujj&u1N1l6XI-)2spgI;ygnRH62qBG zzvt&Ba&y)$J@p2Y1@-fldEuS|=nOX5L87n?ApV0QUmGqx`)%Zq3Es-zdnS@O3iGvG zaBL!LA_7!ksESXf?~ivM=yKV6UPGqsQC(*q6bgPKzh96(oVN7lvlZPbF(OGPB=VN0 z>mHkuGYW_xDsf46IKUE>LqSyq8;U%Sl@ zQ*ls3bA@?+$j_RJ{l*`bOxvvdyp*4)20PK?4UR8_`+7p!ia73jFx(P-m||E7o!;6} z|4;boFDCovv6mzHXfC8e-^EO=;b5baRRvQS0&MdKYoP8@-FIvLtQT@4_yOlesN^A? zrub#T9tO_N=X1>AtQ~m~wNH)hDWzC3AWyH5MxO;7wt``){}ErrRQL7n;ooikFnXB5pCS7e zmX)__%ady$nSKsv{YO(aJ`aIRP$L>>$)2xIZ6>yN%T2j*mItDi=W7Iu%lNs09dy&M zAAP`Kzw|uDA37pDOSRd@&}&;2b{;KVzj#$&;zO9{Ea)qSqjlvr>y;U(WvvgHE-+iW zK=Mo&gAF&>A^2}l=^y^Xo3;p5Mio1S9#d#m&-K0+Ir}qq`4t~qVkPFh@XeL7^Zd?; z3jvSGES=)j=h=9RJbzaK{Q}RI#B~2W*7!JND%pgug(BhiYok|IAx)J)vXn=T28!qI z>g{J+rQ>tEK{MX5p9=OTzjFhRXY`K$7i}N_<120zV6p9h%i)BAWH#^*FQB1i&>`Ps zsp^yfOfR?gdGmOMH@fcxCE7Z43oZ?p#LLcngU2I(Ki#&O*I;w6p^3LT!~)>~QY14L zcN}{mBqx2&i)gxZDWjJWVM-OYXi2)-SF7zwG@6p-B@f$o(69CxVk+3gLYSOy{HwJO zP=YZ$LJ8_fxvZf>MiyP(xE(ku>q_?BLwfn4j=MDDT&S*F`6MA5%?nWs4&m;;u z)9f_!6!-muY4Cy7O^5Gm)&Dm*ECD06zK^{60Eaf#Mb3R6R%`loY5KmXeCRx5a4Kbi zwJvK)ZL30uZ~=@N=jGN9a*XGg@fcCW8dP-!yPl5Y>ZuV%cbZvu^|5XWB4$wY+kvz& zTTRYqz=PY&EO*PRV4^xB7%uAn&Sb(ewvx&yqigwZEKRcdvc~&o|ocqB0ku%czPE(c%-& zyyooAxzcpRgqrbr>1=^wMVY5+i&#E-*ygY~PiB(p3XvU(s(ZOs?WG}Ve?nVz^?yO(1hdlm)B1;6- zg_@>kj`R6!2(5KY+aH_YsNpD#_Y@Tc zCJ|M7t-Ja(V42CofkT)PKDIz^ z1MY{eubNf~lphtymjujGN`la2NQ`TH%joFj29GE3ec2F7?Lori25p~TS|WW@hc9tU ze{_iVupD3D?VaPLxNThv(%EXsxkfFMFCg3MZkp~vNvbBD8Xa43O7xq2II%Ko-wf^U z=?PKJALhyVm_|YWjY@gM#me}HCL^x%!dcvY>dD1{bhTJ8Ev7dA@lNvALe3Sc_v;>7 zL(TC-+iCh!Jy-wVmq`fN&Cg#Ye=be<;B=_*0|E zMYX!PH62(ta=uto#IkkeC`^KC=IahIZ#brRY$~jCuBeXm1>%#UU|`sw4J z723>%{>V=JuXAGTqsmIhF|p}E^h<7<)aCZ@vBb32pf`c(xm6U^>J*LMElT~< zEqgREU=@lSjY~@7;mm!!@8jmo=gS9&c5C-A%zYP3W?~EchMfu=TL#Q;7zMsAsSkXe z`=8IH zv)ISf%>VvRK?+RWcy`ave|*8E`hWtcM!F!bjHG|GLBa@-M?t}4?4|ziqYv;+fT$GE zJIZEAv*|xvbO62ysmD7P7fV*Ae~>5Og5|mBxKe6)mau7ukPWU*JY48t9#<$Assvf1aIaOki>$qsF@bJh-<( zK=1H7(?(>ObP*ppT7C~EnRC_VuGLF!3;1Ob+f%@r+r%Mm4I3C1D5M!}4c#s2tsJV+ zr}g%6vhyAM%$=(+3WSpl{`hDP`Z=iZcO5lZ~KvpS#JIjJe`&cHHftGOn_pocpP zw^<`(=R1z1pS`B9D#E( zHz}v@eI{^rHZ)gY8jicQOV2dBt2va`HhNC(Q#h!R|9MmXYNWKTk^h|-RRtr?i-$Gw zvtf6YCF&)^6%oL5c~Xxt#~ae;u+Gas!ureE6<~v6qk@1- zdg5=k(3%7aqqOfko&&2 z^l%RnvA+C=8-KIhx=%+QfOpt(a;BY$7ps?YI)jF9s`QGCpQ_Z^Kt?C9UN|K|otF`4 zR3l%+YD9{@w#)u%-^SO`dG*Z_3XRifK4;L2`&pjTb7zIw6k z-=3>@5B53PQu`aDGbWVWhN+d}DhHV%;{Ec4FbTE~ zT&HC2Q*^?V)+a|Omj(`pkOHN^u1^=AYDV+>C}@HbYRNys&MmXtra|c^5tRm$=^vC_ z>j$#?2Kh+qiuCH%+#8#VBlc@@i3B|cn~R-0U}wy&oKZp-%}q%fx?Y()8{eLY9?^6C zrHk4N0LmGv)E&~2)fThni;B+ZjOlv)mnET$Hns@k#dXyWi3jJeT`Zk***dTWuM+3q zU{IukbO?YFMn{oKSiD1pSzb9jC)XyTF|xVOyWZ5jhe!Qn3IsSWMPokO7EUpql``xP z^TrUT(qvp@ExGC?)qNH44A409H3;Lf<;`ZxH>)P@?wEqdaL&_2G-=9B@$A+!WzOWf zhH8uMs|S~2L&h}wS9JtZO{RvBn6(2i#0ZG>t*?U|o&qIoypw@Uc3yV-Q-wnR=bvc` zUpjZBA}A}^qvE~(LtFLxKQiJNH4WQ%G3T$Rlr+x)BpnBn+0p|L%!?=8%!EPFo#Ssh zG|dFW6dHMK0ohw}02r-u;2WT_m05l!;{n=Be!k-g9 z#7~5T>3aZz^5J26bFo!GJYRv_pLfFF9B^mN5%UNQ>conBw=qh8G)Qu=SznePM!u;c z6F~$t3ce4TRAqCXQe&+)MbB2EwIHBo1aZnNWdCI0p-r&K!qYAkI`5#uf*^^lX*iZ!-*hWF=|T@H9=PyCNkAE9(r(rUt;a_Z#1umE%PPcEIw6zGvlSHb&#=hCsYNP2l6Xm!DsY1d-~_gB4Qw#T+J zZKJXbNx!^euMm8D`JYreL;fE|&7d%|>7=J2XcVgDb!k>ka$@!S=u&2b@tlvb;sp=q z)oB>WY|E;}+C3z;8HEMLC-0o6N!TFO<%^?T3G^CibP4oYWoqf*&$u|PVt%()1u5*F zp9jHDx6=>B+pUD|Z3^xzEjB6*3S^U*%ziAaX(z|fEM=pw_z4ZmLAQ{rC$;wtU%V8B zI+@AK^O4}f&$#KXzqccL$Wx+27$46c)Dvt+?4s=`^t$-5#hsR9I^v>4&<2BfpZyC& zw_1-N#=53R6~_!|d^TMpSX-l_v*EgEZQo=K4ChIp^IB>L?icr})>kb1r5!*R!_tB4 z9t-5G{L5Ln5m%;5Co8J2k^Hq~Y>EIE*myNQF10%$LN2q^<`i>8QHXEkw#l!>q@`Cd z3uWG5-fEi1s^QiGd@%G7+U#eu7mxzIXpeN;c{KnPx!6mFU0h;iY$~h-ieCs@?d`ZX zn+1PZnMOsPXV3lQhqODj1kP-;Q=RNTc(EMjeRcyxSfJNB)upcslH1+&sufjPFFIyv zZkG!!?7eTl$XP~1f6Nzv+IFbB)^s(4;|x3fg6`i&X66lC%)nc~Uj$3Wl09KUDY=22EIKZ_b9^#vGR6;6yL zh8rw6us%S+uaXT>ioHQ{Sw^cjnBaDJ*Gp%xvx8x`Xr0;El<%e9?HP0RumOnC)%DP? zu5|Q!NA`$@9uU9GP`>P8(L7jr{k!v~$j{HWYCV##n|mYCz44im>{Z4gTd-p0celvi zWJbQpfK?>x8fw`@9--jx*2iTS&Z$gCA913qd^Hp+k3QBAeh4k8Kf=8x2qJF@kt8FA zG>u!3Zi?Z8dkgW}SkAVY*&XECbP@*2^o2b)u{rfV{}t9zLH!2-?n{ z+kwFmE+9ABVYK65@^I^?!k6~<78EIXwt1i{-ze^E(a4Fm9d=!}F&@XrMAvz2xW{Pj z)*4bQQU%`1N-Mw9lY*!VmB0~I)pnbgG#L&ylZS>)ZY*>P5`h^|^hf@iFr2Wz6k9*9 z*F|9F=GI1m{1EMMq_a{Ud{9DNy`BY`*FMpV$5~V#ua8RD@y3y4E?)JDe7&)Rrf}d@ z37Y~ce!UA>qnnMDU7Pn85#%l`srAo;BN6*Mu#?Kj6kmsf{~^Bt7GeA2!md|f`TEZz zKmQ81E{>!|%z`$oJ$jo^r`6G>z{q-XFqu^KQF% zaf+b)jFu#94i~9Jjm2CATYEQfyx<>O2TnXir0acy*x1_9SbnX-8*?HvvR4G1!!rhU zqYyco>yfED6H4|vOTSn=a?`9!^pI1*3j4xj?{JT}(zBhu5}Z+~U7g|R&bz^*dzGNhZ|<#!adx-533Tjs9wc@5zKJ``6<-LNz}p#MEjq$SjUdJ^2h=2W-m_)Q>)-60f#Ka|bRDya+-@xE=?B8y-na_A zVF!plf)DYmdxUdZ1H>eb6$=G>W(R2_AOiX$ZPx1#xN*sPb2ENE4fpf1uPvO0>lp4? zE+m1fL6uDVz5!8Bx#qTEV|`ij3*nqWzkn!Yh=D@I;f;6P6;M-#lc;$@sjvRy%3yxh zcRw*cNm0)I4!s8ApI6AIIa;AS z41Kjr0HID~L2a9S&?9t4=v(9++-dBB1kJo4W!ayHdK=6~qjg?^&uZ8Z-~b@pl6|k{ z22nYpW_t+{c*S7!c?-!8id=8+FgbHpt@S~C6Nz>k2iiqBdIsdLufLsq8NqF(k{z|m z?V=_{VqcX>TJG^{(KE78x3Vzwd`wiCi|qS1$4y08tUJ8QCH8EM@atJ!U00;@T6!1q zRoGsb%dQ~Hdj|**e}4ljoft#VO}eZ{B;~b&qh#u)*}$I(4B_VG-{H4XSNgpa2iC+H z)FzV_4n=BZIF>MIWiolBxE-{n%ktmu@_*~1o!~e!FMTszdc)Nl!+Xlv4(s?_Wj+ou zCNek_O1n)+OOY+XbBH|M9BlmVdXQwrxFMbUoG${OakpgEfidBrr7KB{5zQFXrcY|j zyUC6DwYQ^7@~OJyYzXuB?I9EdF$^(t2h~^D`T>ICmEhigt>jyNjq*;;Zj5 zG%vDA3~c#2J(#H5Q%zP!l|*!P*-AD)EVoM|3>e-_bG^`fBRzUWp(QYydsHDD{q^+d zlLaQ2MfBCBlivg3tGdarv!ND<&=3yPOls7M{!Y0>Uduh=HhsM&w^E2PqtGVwLV`Q~ z>=EGR`NnW5)akx2>&#?VGOPw$*`@!@iWJSl_A}Bxecw=IsCeqntOPo>u%fFx{cb-4 zVc4&c&#p;#KPln&jf}!hKlz@PbRm>kp^-nMBE1!abvtjN^U43jtSAWR31`|);hg|M zr|O6KjzD>F?ygT6Y$QHR%#cx2m?>Yaw@|PtLabvf2vT^rhg1R;nkEN-3IWO6nWVJE z9-ySk#9}}tJGuVU-3ad^wN#Y zgq1)TyN=ttASEWat1_?JA6tq#q5U^?mSe9j(+}iMjC-iG4H>^+oVJP)p?GU_IhERj zuiZHY(3hv2$cp$*zTDm4G_THgz$3&6trt}wNdoC|3m7w(X|?+k@ak&VW%(ro0;2y$ zuK}r(gaHW56xk}Ht+GNh{o@(5+?aL?MfQtsb-We&2 zli2*NR%9~w4CE57S~k};^csMcSeLEjm~s&PYxMbk()%2e+_q!$Kfr5-)HR``#IN8n zfGQc113zvAii2yPSDCNiMwd^MdhxkgmRO=wTfs>$KG~aMCCmVY;5UA5lm}3kb#hy? z%)KbrXkq06yoN}mL}bX0TjumIh!GRH-1Q`eMmwwFbRVYlq>9mvC-)@gQPb)oK^fau z6AHOSBgXMO73amuuR|$}sYV(DB04%$r@7Rm_|h*N6)Q3@E6LiA!_IWvmu5RvJowDk>jK5fO&^!5SO`B%bgFkuEGhC&{uANfK%Exyg8e@+ukWWri2x zvvLoBu@<0)d+82wuy&APd}kbz#j^KSQ`^VBt>*QjW!qK+O6oy%g6;C=t30+(+bkam zI8l)A_G?yOyo&Hw*etrVZVc0B>ny2C_Av` zd9lT?jEa&zwjWPD;={z-E(anOD_Dy{4b3>_{os>EJ`-R#VuxJ29I>&_u9T|CKFNM5 zB9zqnGiYS&t#uD=7nxF|5s%uq-~$SF7Mb@cwEYJh82(bWpL3;kO7;zS&ew#@UCcR} z#znilDzWUlj$>BL{a|^E$?^pvfq}5sb*05YUnD=hs?TKmv5`?!WA!7&?FyrWek@#( zdi4p~t}iO~GFFWkUBq+R-<(E2N1}1A5D_SO&yB>`H$5H*5y%;+sM}xR15_~m_ZfV@ z%aA`czt&IokGEZla#8U#&)4s*CZMLEWUL`7YuWwXuKo1tWVpUBZDz%byh-l`XNC8% zT}Oz`;HzC1l%Daj@6`{2NJoZ_NRbvt0Mj0w;hEzIK+Nb)iUxL_lU(DG3nK;PSMdv- zx_yF$>`j52XU6SBw*HofKdNQ+DW`oI58p@I(s8ZYtK|+(L8v0(DMJA!=pJ)&SdsltG_(*;8 zr=q(4^O~rF2lcrJyfjwIap<@u0a$0=n>@-FPv5!-^SK-x<@}~M+{Ucu77}qPxothU zMBcjKIwL;8Hr4)K-p-4K&B3dKP75g+JZa3{HOT6gK2Hnx-*8W*_VpE7B}e!wh>ER2 zAxN=m&C9?no*d16Em2556SV5SyVM&7YJ3LU)QMoRthlTdB`xThh8L9QbqCY0gyl*k zmY0^lWw*pxO@q%+C#68EIT{yI?H<0I8{j;O1*`Jr9-CZ_(PTA=5g&nI6&(o~o?d0Cf%#IE`9U3D9N(=ChjrLN90 znL`@oe&^>8$S4%pqS%JilLecuhv*F`6CPV@?wGCaR69l-JJ;FE*lXgyzpXE}T#X8U z@2ZVpjsp@s51i{JwJj*^aVhe04o|u?=`a0^eUqe)pXPC@Crc8Y>`8=2c_C*QUa#_; zM|-gnJjbQkC#+`p-CU8$UpsfA(0sDq!HcRcg935muiYdP^w;%;KJ`0Qs7Uf6=ko>9 z*Sak3^NfNi{#l%%YGkgMZWO5Jx zv)8nId2)sVaqb+qqymPaB(Es$^q1z5$VV36-(Vq7g=qio!a)!uSj&w;v}(FWh!q%u z9gsXnX(r5c54p&92_qr6-K|69EVv;-Ms@sG+*}pKht;Q4OQUCuZZ0$vOPYjyUqM$AAyxDt&_Fo2XuxOP+P&)Ngvu}KZz|HT};uc2_;f((Cg+aOH@%@u$T zlI-t%!j4z~2KjI6>q#rN#R7O=-lvhj9HZvl54U-{J>G|4?2;{7h=-8BVBf-t6o5%_ zb$6G}g64pCfGxe#7#WM2K>Utw5up%@&W}tCK304?Q5)`~wciSkMCdO3FYPyyP`T@m z5}8MGs%Ki9iz`Zk>;ijC75Na+DTm&DAg8+cu>zmOjh#%%{<{6M)vY96pexaP2FH^d zfKoOLB#^FhE*X|C?(VmhFOxEKo!mBiqGwQiIsKfi*U;}?2TrN`e0~@3G^HNB;yfTY z5z#<6wkqhZf=b-CqTy57grOr^agr(mZ_hgh;)`p5ie(QgXeZ&Rf4CAxl)P7EP=-KP8|`T-EIAnjF% z^~uVV37H>nMRfBc>1A`vFVjN*cz48LJwgy%dMSoYp_8MWr4%1 zl?m`W0rU7AAwtu8GA+(~0lIHKjXu}9jozGL|@cx|q?uE^e-18M~(_3(%K!q}Y^ zIp6(>B)d2C+D8B6iK#OoQstHMWe484vOebDumy*`4a5{UrJ81j6=z=?i9B)Kh|Uxd z!-2>E5_f;hZ4>wHrOu8+KQ`CF!*8?&mU2tJ4yCn2Z*oUc_qK_Qk7V7f4J+Ycyjja- zd^$y#MorEhS=_R3rB!$%?@Ro5Y-CKZ4H|P1d=A1^$l6Q@T%XnLz571Mb!mlzq>etE z%Gta1^BZZz9;Iy9_oKoG4ugni^HJ(dnWefLq)^3aq8=8!6RwSjN^X5*Up?)`u`7xM zFJYa}*PUr(zZ3hVTSk%?_KXxN7`kmll;FE|On;^@e_DMJKL-F;n@;m5jv4n&v*Mj6 zY3D!7U(x`4)7H&fZpAlXqT8c(Cqzm)3TL1KsTDnXRt7;8HffiQL)03wG@?(2I_KcA zN=UX@G6#mSV2P`lX1Tpq>JEQJSzrPq!gBDn6fXYi3s|d9giKrJxT{2gtI$Z=eu@MM z4*G4Qfl!38KEk&Gr?Dk85FU4J zwXfaC5(BMH9LNii{mVmXsDkqrAcp}JF)Z~f{b;a{r?w_2z^}x73lhZ|DNGgLoETV^%hIkf30~{iJKGeL_!QYk%rePjQvTvK{MEyCv#zI7c-`Wcwy-M8X}^c}K(M;IY#pBwak!G|7|Q6Y?_Buc)f zq|_3(=j=*COZpnpk@c*EA>X8EBF5=32}DZsaZX54l^@hJQlGvO6=$g@WHG-&n0|Wn z8{=XUVi_S|Abfgf1zC3x)GRa7RCpmq%4I{e`AqCWFok<=D4CW1g#r-)7vS3e9XEve zopG;oJh&QqA9&={5^UU3?0Y+Y(VOW~0^R28OW5EE4q zrGFT-n-#w>Oicle%urKLk75iH#{Q6lNVOC)-e=5%=Z3AV?R9@KS`dfj1|#`SKV}}l zf+;eMrToUH_zfu*g7P+*XWW-=6e&0Fg-FjX#XCwLn1|MM>x0)qw%z7Hf@4$O!EXRa z$dz0(L&f-@q0^@%dM_`{oN=!^}>M6BjO9@+qxbg!clhRgvn)zmqTVpM6A44;x$ z18#H;HWjHi)G41a!t^^D2~AhYOF#D2z9*C=l&>);_QB%9#D0C2ui3gD*=p9h?^C@BsCv#(yR3d8EE7}=M&qbTq~)eo;utgjSy;z$*y?Qq zg0$Pe7&NI`@Bi5Ayi2BoFrGLs+`jfg%tL$C(G1|7u9Fp8!@%#r_H1rjMO1>!C5ZBP zFZ^lF2=&5RJ0Tu#*i^Djk^xF8_7O$cEB22L$rrZnjr$7M#i8Ig-bm+E7=PLfBKbcT z62{YgshZXE7M?cAOi73KmA#P&BIHkIlMy0%pCT$I!2s8{m?QUl`V2;-mv zfHlPgHBI~;Mm6n*{h61x9%s&YvN|0mJg&+R>yex!Y50 z8au93@TR^^Vi@_TiP3N;e8>?GZgzqiDY=4iDEbJ?tg#EF`D{W z=>GgHpzWpHuztad-9bD?qMyyuCx$?w;e=g9w8Vu5A&U(GH z_$ROSYbF#rX+lNV>BV)_pF52W?`;K8%$^AKk-cSr`*-%%(|Ult1(0*F zIq_mhvUa!tBxBzOfWfiq5W;Bv@Y)b&sVPIrp!u`k4e`if@bLm*&+yfX*LBE3%7Y@Y zu;#G1@OW1?z};eq`vb*x8n!39fhA@D;vEbhFf0>)aUJZxiGk2PEz88ucbuYZeUxf9 z&6=^T%dgWg;9WKHmVr-u`-U>$%;tJM4DFa}VrC>g$e-u}s8-UVqu_$28x#h5w~qrH z`4|1+o=t0BktRw~;Z$qss9m$Y>=l`xo{Lk4HRYE+koNu*hIGl+pT#f8CC7 z`UveDG>+L&AHPPXgo{I?5UTL#`r;(zc~IH`c8e2msqmO@zAcx;^-N%QzS2xC zW8V$@5v~R~< zmKOkg^a}Hd#iQsbP1{!_17!>?k26mI=;q{Ie*}MZID<#d?xt#%1f$!I7Z0Hs4*2Be zaw)_?wX16gx*dc?JsG(GRB6M-U{1IyV*dE^*$>d~8SES>030%1qGi!D)eI~2sLW9h zl5V>fd1($)WYgn&%7z;9^nga;hCKFNOp$-y9?MFj^!9r7FO_HJuf>l`)pIq=^;@RH z6}XWI6a<=T+&cNET{W9sQXq2{nib&)%Ko4J3S~?KIIhp5U0%N&!PQww_1TFELp3aZ z#9@6CFWmW6$=tXA4|-u+A`$RlMyeo&j7f^`Qoz!sc=1sUC_pyuh9i3a=q2r#u?yOA zOGZt1vcNOl3CY8m?ub5t;Uc#+uI1OuK0#S{hZ8;eYX@LqbqoojRCtMo&SK3Ye-W~I zHO1dAp!nwSdb=0a3`H+xo8?<7Yq>003t0&6iF`O%8-l4UGc32%s_+dZ<_K70;3h(DKlk-c}L~_4< zExtI_%>Lk_U#uI?pi?3%vioNi#*=LPnTs{yJUt5fa2@rb896%QyL;sg-8?l3E_c=q zK=q*|hUhBtHdvb`Wo486oC;Nwb5tyu$Qko*Hdf!^BRn$n06Ii zdR;yCmQayIu{yOF6*!eLOnsjvu5A#LKXYh9x;P-&4!TLwavmnlC40840zs3ShkutD zpue=x>%$;I=7Rik@2@vcJ85{-ZEzjK$G%%B=DBKr?i4hs-$5^3S#BqSr+Q8WmnIQ# z%UIoa!*B9nada4HSG>#Xe^etZ zM-n`kHYGIDPZ7o}-1!AfG}zoEk|RE!BT_+*TPspaVMmqQDv^U-Df~0S6rz<08d2^$ z1*BIpiK5b+_c25~VJ#j#dn`M%u){&#{q05P%p>!4?dq2zKPzZNne1Hmv_RJ4W)86Rg`qS;kdCs>G%ZEs z6fj4-H3*7dZ3{*_Z9i9BcDtBuX()3L^p9V6&<=gm?>52))`nH&`mNBzBOsz+&qlUW z5(%ebD#K#4V3m&3sikOHG=3MT_vf8%#c55}%Xjx{i8>EPLxO}OLbvJ8eO7iyZ4dV+ zRK9yO_m0y?_d)AXq)hiy8Y7%$#myGz3iruvV*?YgE=<0X_>&@83;r}8-z=f+K(UC- z`;~jJd!!!CZW7_slwFGpgtrgN3UIV5vh@vIN#AsAMG}iZDl|=ze*4^Sr0TYvHxa%U zK+*Tr>Wwnsl&1wSS~I)`q1MeC- zZcINB3W8=nkO_?hyY#9`Sy!r!o40j9Fm4**^AH>SHh*)CFr`=9PTbjy)sfQ3mbc@R`%27_zGY2g~okhFSu<$Hvh-@HO5=-g+)^+hP|FsD$? zj)Ai{F!iBo#%eH%p?a>hfguWVVf+IaQkN0u_@6?(BEaSG>f>*^XjHI3XfaX z`b@1)so2wtTG$^B9zh3{#0fs{=CH}$W4Qcoxz9aTAc+ei4l~w>{Ev`ELu~15my%+&6n zOiMR($m})Fqd92lqdGL_)I9$YP$S^o%G!L-1#&02)|>3P%+S!|^MPH0h^qPbh9*J? zA2!grOdqnxJGWrS+Osy-hNn@5@hAKGFgC(3)lm6mGW%!s)k_nPV)(9A=2PULGD1_K zAS7=t*?R&`xiyX{60-YKE!8b;{^OiarWP0I2#YD}sRw~Cjo#5m3NKKv@DESlqM_Bx z8_@OT9EOuG2$ouw=4w+S0iVavG*T(FA~Xx1XVc|&mF>etJHwi!@76Q>(dLNn=AH{n zy%jdKB-SfB4+u;3>D`!4`6A63#KZf-$BP0%YA)J!-zk0MOIR)6rr=ZW)vqIfSEJD>Hc?d?xv2B0r5a^QQVUdA4P4g1n4YkffnmMOR(*}$9}PwPJ*B1Q zyS!)5=@gx_uF}sgi9)Rsnym#VW=f9c$A7QI)%$u~PI|O5-?>1C?-lgR{SIFC`c#z; zHa?dRRG(n-JM)}D|JL00s20Ir1VDPd{6%a8n=PrQHSDGQ1;cH77R7d5fEFt`Dv0u} zTEzBsaGQAE^(8??rRA+2mw){2>G^R8maplWykTzyY>b=-lyzw9%9q$;clpu=Kd5L= zK{j-d?59@Bh^V@d!Fl77Z}Dc`5tB$Bec5dUqwu>Qy^B5 zt?j|e^<-|(+?7Sg@)vo^sX*YnnRv&DttRjk_;Q zY|LEomY-19BtoWJ7a1<}mi>0`O5Gp-jz&+nph9phXq}TG(XO!p{s-gJ-B8p{p(eSo z=xKw&akn~e!E)ED>KdtGsG;8toBBd9Gw9dx+RF#O>wd|rNXKf+H-j}So+}sRy4+7a z?R?mz+)w9M;=gtCl{K4-?G2|&lA-0fF4@Q1g-9=;QfzuZ==2&&6Yeb>{bYMc&nJ0c zx<1*CVl-nTQyDkkn?0-)g6ezC@rAhjN)sa3u1-xPP10B*O!^w2dIsKWZ0jLWEPH7G z+O@KDelmBjdr)wwV`6uq=fY2; zt43V+am5?&?FTP3dAMfQU^`Eywlib(GJf z!%$hS>`X|PyHf(Pz|oTydqz43yPZQOwxWFRk+IE?(#QJ!lMAKMYRgVj1{aF`|2BN`hVbq+>5c#mSK zQqZE`fd*rpcg9@_Sz4QNqz=R_J~4a{iORq{aoQeISLJ=x(pA}aNE}K3VBj**uzxeS z47NWNI)aT`dQU1v5s_&ic$9)k8^Yz?Q|Exq~pnTiAHK%D< zy0-4#PQ#Aw4fnF`d&wql2Ws1&xGl|xlWURi*#K}0EeMd4rbIo1qV83$~{ z@g@4D*4THe7ZYHQU6EO|VyZuE(jV*Q-_C+U0mTPaaFz0Hv{nm~=lU{{?>NVA_vQ1( zIS+BHj^SGAKmYQNC%Z6F_)mI1r6+?&2#pkObh$lQC?jr?FhgqP-I_nk^j?ncQ2A4D z{nZ8u13Y|QAhmr9@Q`G@ewRxPUDx3dcQ(D-;sG1p(%$LW=mrqb{G*lpQ<5ZrAK+&* zy!VF-$RPL$OG!8KElWrS4)QISvW`u`tuim{1k?VExcQaDDrcQw)6!9FdidWLg{fOh@T zqX@$xVEe-X9|MTx3^RF@go!V25UW+9w(%>FH3@x$^-tQmA! zv3ITB?vScNr1oT;i?pP^VZC%l&s!Dh+ zVD3&MORe%M&XU{1PQM4{J}kL$Gi%uBNNPrK&y0S(H+yvAwxL$ss|iHLlb{YP6n^vev%c5WzAvNe{5nY?Xc z9q-i4`g*WHMs~hyX*;7x7h7E0u~h-8tbwT`PvMI` z6DD^3$11?1OnyLc&iAK^*+@XI=W-=XE`NJD!qsAtd2_t|$!d!LUK&4s<@=EzsfBtq zfkOVz=ZMMyq$pDO{+89k!tX*TZ4#_xHxT}(=YKq$0^_m!%00}yHn!Dw^RmxPS)9(P zs$J_X&<x>CBYLxbThDK-mg z1Z$Nf=v0m{Ok5WHK^I{B!>Cs(4C+vvIdbLU=hICSOfyWA4B z(XcVRv&-^k(>U%!-aYJQ=`P-}OF_a`+&*iw0O&R=S4LGO^uFHF?M(yo@PgR;_cv-G zuj}8K>&{FIKVs%S*7giV z?lBq7GmO8DRIFB>;w8kB5hRBtH5>%n4|}iN;#8{gxGZs1L{4t%Ht1*gpw~z)lbN&U zCXrvx)qI^ZYoQ)y1cOWteKv2>o4rVz)gy&UoywX(3ZZ2pxK~s}|5FN1Fd~)fcf|&~XeF8^)gAY1Uh}3}r#p-ck70^jtJw)e zs95Z`Z_$&qGxsg9RucDPz04cix-UH5N0(dcN0KRl$gNvB>zjod2gKz~2?jPT3QcQz zY#!H^glZ0+Coy}erKRmLoT{}W!9lU58U{oAD@RkG3X|X*A!B<);rf131B%9JC3Q@o zeOV!^ntRcsgP~6OU5UL-efK2jY+GTf-NQ|LGfWG@Nx@ptW-IoxUZ|logE}_${i| z6Q8F5B{oLM||;Pnn(KWoaYktaN0CXmO!`X zQ+Jm)c>a||T|?e2)kyP6PgrvaXHBBqj5az;@Q-8E@}|?VrwIu$^KQgOlL=yMu%%^Bm1@fg7!#fLo7$-l!o+MwpCPk*J+U)NL^9atrEAYa zv8a?N{zvEkdk50NOLz5%Dy@|U@TG)If9}Gn@)$j46QUx0i6(XWr20srT)gY+t;s~m z%95G$gk2Gl*u)RI0xH*mxDm#Pd>U_;un@w0oalif4O#=0G9R^4=hzRwPvxrlEmo$6 zmeXp&oi6waCqC#ZyFk7hOx)6(z)nx`rdrmb2}VM{$p{rzsoWyc}nQYh@YT4E+UoWC+fdh zvt1e%4OA(bgXXG+SI5@RKMQx2C}w4hfG9)v=}Oa5CH7hJ35B2>G=lt>>U;Lvze9z< z(zzHJ?pI$EIlmI>wm%~h>^*PXj^js<8&=nw)OFm4ja9ZqrdqyHNHJfoYz=`eUs);m zRqgyd%p+1~p0CWq4#r1r{2$1SLNA^*Nlk~-dKz^a$aTDda~D)D$nR`ADM=tv>u-@Ykv(4%555%9b%aF5z$Ekl}OCl zZw;lbL|io`^flVsChF%I)o7KFsjZztuyTh2rr*&$qtgLDnPH)49P57eVDbra)o$Tw ztJ4=GYOJht@icFxPwt(LtGt^rvvrHSh89(08E!Hf#)X(LS~Dp-EY<0 znrx2AK|(wGRBwga>Jh0#K#O?B-7++s=HW!g?o!*;yUtHasXDGTV1YO@><0)rJG~mt zr3Xt~nW*APT9!UM)BfZNhNq>+^P_5-K zR1>61uGOaM7abhW@afj!Kt*imX64>0mHoR3@svS3gK5vNB~D8{W#J!mgs3Um&W;J& zkj#bTp3;iVPq$nLV>kKy+eh~fLivCIw)(p~ycBxhnyA}qM}!%1+sEsg)b_n_`Q{gO zcoK>fE1LS>%(^OHK!c2MtjSK^Tx$Bmi|}V@Sr;yu_``fj`!ophdU5UN^{UUb(ix|sewmBXGN@A07vq(xMHweOAHN925R#I$9yp zHqT z@ceWJGsuFeDpAU4w1uKlma?c6h7em8SC&L>dXTsG!J?oiV}Wb`3e~)j4BRyA5$^vy z*YN3IN6f!;schai6h!5^$r@ruJH7-6KPs z@P~eW=Bs*CurZp{V|34m&1uNhjINJQ^@eWGhF?n1Y}Qwi!V1?uN@rtd{m{SSY9ld< zY@)08g>5IGO!`60&8PCyh_xIdC(xQ{y_Pd7k%BA z`lZhyRR4Z*)H4n{MGPljuslx4I8IWl(elj}R+3qbTvfLd>Se=mLUXn=ic}<~ z?B7i9l%io7UbHFo>lM1S<4O(Y`Q>z%1Bx>U7HIRs)G;T<3>`HEzO!F?oKehIlRAU3 z^oj{kR~aA&`MjIbg-p~G)KjvrdKadl9Eg2@<$vd1Gjy~a#ueO}L^k{$ZZ@(BKAouDsj~2{-b0ezq$;9H5+x991yet4RBh;N zPxjq?x4eVJalYFtXBTszn^KPpd73$2skh%mKg18Y7Z*mOt^AvP{02iAaz%*!p!YDO zu{F@1a#?51WS3bh=ySWOV?*Wo!Ix$pOEZg6;OKrmsl#ZYu;QC={jxdW)Xu&GaD?Q_M$uADz0y%3W4-ku^i%5Y6$ElZTC#71c9yY=^P<_=@!@I1 zpF93tgN3&1(o)=A&WKkJ^E8aq#2sJMb~D4Mr>d@gC~zcRsaoE{E#>*lcmSTYfGhprdnsj zUGrz|=(CSkE^~`D8FQ_&wNq3UzmaVlN_b47)Vd}l7LYMLIKW=m@U%GiF@GOZ@Z*@m z<3oz^Q}1@{N;o@$ai@+f*;>z;JWSy+s@<~N30P;))5d>)rgf?U+x>Ys z!1b(Z7wXvUan?}}O1{y5ptR@Y$rmc=I(=UqPitBvNed5I0e#gv=$6d!xf7x}8lNU< zI6wnRRNN0C3+Y&FLaR?&W-a(8svKM1$`{q8Qq2yOPv$Pw4>-RnTl?eG{%*3wcQ(ju9aZd zh~GGgBpN{*E)&gas)bPEwNkA%eLZ-=?>>IlxI z{;K^cb-9pqi>3o*gxK+4u&oX*kV~kztZUT`d1a)Q1(aay(q-WWw3cfix1Dy%$X+Js z_oUjfN#gf9G6r;s#FmsUG<(9XI2qHL!CW;oU;BPLumF(rA<2b&M5=s<_e$Z`p+?)x zM}^US*WEnXMGxl5#+o)Dl%Vi&KkzMc)aj{IJOfjRaQ;D#z@+>O%u55b=ON+|3B<~ z_gj=Kq%4) zf#iO!wa>k0uXFx`yMN<(!t>?JoMVpij`6-TU%r$eywWONsLYDZ_~uWV*@nYkb8@R! z&I-xeHL-5M>hS8Z(J!H5>vPfwSr@k;trxw_d~=zs*L29pp8Ycr1GT(?3`IRU3)g3Q z^8M%Y;N3YPVQ&v4^oG>u;N#AZt_4;@mms)Dh_#6@0G{yLNnPv>wM8RN*-3{Ui223O zw9E<4LhsiYd$L%^zm&OHA3_XzEx=U8+uoQ~r`5)jApxgF!U{TcU$0#Alm=qlAl)QN z`##Her#FFbK0`$(+FS}7VFF;|)bF>eWY?cfK4_Co_M@b5$RuZ3XIHKJ^JbgP4RXfv zLA4jwQ=gn_8r-uJgY!HTO)tWHhbHSw2ndQx)^jk$A+fs9s@{1eSFPI5t|$4pzP-Ae$3 zvvB&t$7jTe)IH%O>FBY((7^x{gf<2L-aAMjm*)ZrCi8G8sg94NkxpZVqv05Ey+YUG zksvh=Rj!1nBdC9ClaQ0X6l@$(kwI-G-hc^N@`KiP zEeo*pj4g7ie3fFBf7WWx;lnC0H|>Vmj1nt} z@1>DLYLIbDj(4qqEWStk4`EjoFGJI%p;?-!yO8**sZETfX!F&uyE$S4_964Ct2@ zaxtr|?X}Po^&lhQB&WLjPdEGd>q8)PIEI@#!35T}$4b2h|IA;OJ+xfyK%#lULaloD z;{kPaa?{S8h8Ji7a2>D1XRJB)+w-S(Mk{Y0dsdJy`1#hJv8iShkfPZ(mLE-gLu?c? z$Gx|vK_%m=^7AyB!^n8smE=;MyQHx&6+60+&vWvZKMDgm6#4J+ymGsiCG<%}?&NgA z=Se#dGtU|w{p~t7t3LZ=-#-UYb zD)9K6bAtfAgem~;R$psVO1Q8|np7WvWbo6Ge1!P^K8iHbE|^!NCsU4Zm1X0@%C;`{ z>kmc`${cV9#zUh92)t8fbFX-BGF2v{2Lr}ny9uXLaMlh>_20ePxOtrgb_4y-6-)WO zV*32?j?Mkv11`Dj>C!v5O>}o!9%}H<*1^Fx3Xg+s)Cx8Cfg1v@0|%x{2&~mzXH;a) z6Obncj|c0e+-)#N%pKYVerq`bReyn>9O)tA3nLzeP9=)l78~VPw1ypjP7~<*bYJj& z{p`@wsArMkyf&P=`D1;|Z8p(kCvmAoGt<=0rb9fh=gtC-kh)uA3W8(3j8mfMn<_X2 z3)9_ySgp(#n>#WxB@d?F>HNdt{tG-+{ez(RhdC|rjeiFW{>HlOZxCG1OLwK`ApG|# z_3!^Js=j_F)_x~H`_(_z>92SA&lmsun!Tg_|9Ytt%cZi4czJF4bx3_7qjrA1WklcWgE`x!*cAOr%%<>dGt!- zo?`~0Hs&LnB6z+<1M1pRm6y6RjE*2UJ>Ss0*W zxv&Q!kdQR*MPK#GJ?Nk;iExQEWs&ofYeAZscFs+h3XWdd((>2G^CikJ_EorG@|Yw8 zQ>0_-iH&fvPg=i@$)dG=heY2^Mu`2Q54L@imfp1oUSQdIBdv0ZyRzL$3bWI{*<`ib z8o1EnDTw+;@Yh+=dT`A>DL9WY^(Lb)7n^$zfq#1alrit3hVe+$6(@8k%B$YY*Vlbs z`zAYUhP7)=`uSCibnX%Ff?qG~S^mYcBJ2r&`-P1j+}TXyX%t`0FCHsFZcQQA6&69@ zCesm48t0h~A*Wf>a)cDY0u#5$UOZ_Ved#zJ^Ho2se5sjdCU#F{A z)kL_Ta+M+W(l>$wy)&$}!tlpY80>yTTvPLP~Fr zvy^d(G5B#Ia+vL*OL(0|qs8C@uEbDUaH;H<#Nf5V@qN80>cK~<!o?c zo;H4O?`LAt5A&}!<@!cTP<-F=^abGgQ|qs90Jz_B_s(#Mq0Q}b``Y99jc~?rMV2T~ z3ELCv^dmVG6E8tm@{q+87z2C32b+D>&tG?Uqtfv+Q46di$D= zbrVfLu!(nLBk$TU0z38&r24AjPOQ-LFRG1FaqitcFSdMbQ=L&}lyQms=~*Z*J|$s5 zqz^p$=IFv?KYhR4B1u~D%6faEl#Z0&q4AKop!^C(saJtz2$)w(f8JH*2-T>l|536L z#gB-7NB}unAh*d5BOQE3|4eY#5H$1rY{emtADS%}uGsl7ajB-it^w|yE)Vo3Y_K7y zgQ2TjN!*0UVnoifDhQ>45#<cO9SWZoPj(FnUm>PT+4JhIv|eq%5_{h60&UdVRC`Uaf>`r@83 z(`N?BXI$Z_cB1*`JoV!%HmWAcIvR`<)Y6yd?ni07ojpso=ilO`sYtsLHE-ANmN7fN zM;pOj0fLwBox&|1xQ+`O=PyLsOn7lW=r(~1+#tvNFdy50#N6O}#MZ#eM?YbSqtMu@ zU1SIOgnM#&NpFcizgTm>TR}Qy(ocDaUQY2oPOTmZEcch4YTZ@oSHw{hKf$k0-EG(n za)4Bw%~v9#>u@gALcAu=L^7P(;Gm9%1h)>6Q(Ex-tN_%f>h;ljZIjrgOd;QXe8R(s znEMBRyb0HC z7AoW6(H-Tn(>AFZ>az6W7}`I@>H3ec5R{hBPP#e3P%#>l@|x0k6+IWshSspw4ZEbnXEJ%E^ggsHfZ5LzCB!(O+A>QFy-8NGKJ)p^LT`1 zFM}Nxj|+}KJ9%r(OAjVp&)>&L(bMy>`Pn!W>D?ESgF>vRjD=k6z2==u1tQ{NWLyEg z0E^s)@d2FFHl}E)S$22YI=+5>Pc&!?hUdr9jSS$PZ9+_^qzp~!jlXNAH<_Pj84syt zJr_$NXE8&&An+rXc0p*|g@f7}OmpbQ)sHvT4V2{SLIQ&gPp&r98umGf;Y&SG@9Ei( z)v}{^8el;fUVDFghxG4nEU}kk_0wOa+}BGBjDEq|!Ar%F>nZDv@|Y&?2kcDNfhoO* z{%a|%na}ci&80AoRe?hf7_Roz(w++YNrNDmXQz_R3*VKk<|QJJ-s$a0sOV>DGNW0R z(nhX|ZJWwrkh2b3(QENbkw)P_>=*DS8lbusFK&`z5$G=OHaKDUB%Ho2rui`4L~U() z{72RV=0k|CFIurQ@t)Iq(0YC2OId}{b)B2*Kd;UP-0OBwyacbd$BVVuyN9gi$TBjZ z4NHB;JMPLn4>8z<3yo6+zCqxga3aK7BwbFYP-&)34oN5U?78EOcC003dGuCjJCZCR zb*k)^Ctgld{$S3fHgv|al{eS(?9rFcW13>K^Op$!+>~iM+h4Y4W{okSg|7_9#m08L zw}aUUJ->S`d4|io_Vdd%^0Cv2sZI7f+)wPzzPV3Nfh^52e7{L#A5 zpN0f(|Lwkyi68bPe=lCv&ETswo<@2G_MdM$C~(1Z=YrDXPfH({g7(KJYd%zwZu=q5 z59xeCJ&gU$wlMo+ok};m0;mATU>Y=r=# zbX-^Sd52Uj-{&0Ja0Kp(Gf2j8+O|4KQ|Z>O3p8EzgAPaIZa>%=hBGu8@peqKI9D91 zP`=0Bjl^STQD&RLCt_&tyPmUCb%d!r>|?>J$-tTZcyR8%_p z2u7uh8~rhB`!!S{i=eM^tXDB@QkC~EYRe#CBMHLR;%*0;a1j0(?=U!=mO!z2rh)K> zXkkV7L*5+-KVSRWJ}`Tl8^P%DnW0hY8c8Ux$Xw4(OMgQ|hk}0pF06DMBkW+@4Q;63 z^&`Mn`7E5d+*d@JjvQU}$ejuP$=A*oNwm+Ypu%$w^JLkv$w~LML#}*ZB@^Uk3lQp4 z7IL>bTq`a(nvqQKQgEd(IL_FZHQ`_?UxY)O(Tj={F&1x@lQ;5K$pt@?3IRFnlR`Ng+-#Bl-j9vX zBZHgr$$t=U-x6}3=cu{935FJLv#RpHM&O=3>Klt-7T3JG5G>$I`l#D8%Gu|!!5By- z(XKkQX)2ET8r6bo*MfOEFFpL0??0t`R2CXQP=S8H{)3+VY&3sN`I8n%AErP9egIXJ zK9nkzU0Hyh8UI%6Yi4?oa~J->9wy!g_k6!{`BZ8At*#Zn4dM??s5ozTTua|% z_r*6I(AWo&MZcl8qs8!%PeMpyC6t{r;v;w2YhKR)=ArgXFw6!U|0}13$G#F;V4XZ> zN>hgqVX)os6c~TfWcO1)uIrs@sYZ)UVrBvojq| z@c^}cESyE=Owy`Zq+T6WI+nXdOJBV5R%$ET4vY`=&Te5@&;%NWRc(E8z^MreV6zu# zskC<8l%2jieqs==cotH2%~Z=4F*qv7Gi7R8ou5Tc5g*7bzdjmk8o>f-Zm8C^>lbIb zO;OL{jCnChv>hO-tu?g>eXJ~VIMW>P2E?SQLRzc+>*$t5EADDb`pkn-J>xV6jM(nm z_nUnFchV2E#P^LHen{*=IJjc4k4xo1m3`G! z{tR2<-ur&WJGw4K^=y7Wm)UdW<~^sHX)FRpI4TZg4Jbt&rBkf4>R-2YR%|}>yU~OS zt!T}%t(nGPP)jRIWb2h=sb%q(KLsm~fq+(+>5xyhf@$ZEsL@&Qn^}@vGJcuUQ0p_% zPAUFqO6X_fqAP-1#p81q=q%H!0IEDx=+?KZv5C;+K$X{pC+-ZxQ%IvyoF(PH zBodC?H5hk$6w9A_epX*$b!4MnW_`MOj`{LDVX=^sQOchxs*ge8KViz~EY`G9wvr=fWhv+1KYv1 zcyqF$O}`h%oh3AvxIkpYhudivSrCKDw(~oUOPr(@KF4lc-Sfs=O5bPfqdu=>)8yi4 zohsUwPm6MMuI8rGT8{I-6H2>uZ7CkS!n!qI3^0?;R;G|jpF_t=kR2N&z-b@-MMZN- z<4e=%ujs(}W^l<&t64+h=<*{JQWr?ViqBWwI-zpI2YS`Z8n$n~jUb-_vF$n3!o#*p zix@AFA>tD3MkAU~QyO!~3GdPH05kdP$uTnJW8NDbPd8Oh;QpSU!o4>MPo6r&ZHTvC zJZ(4W-ZecfP6l6bob%iE8A&xZG}J=GjsiVpDw{5n&k0?oppErTcB@UdDR=@@%aV4q z6xEmJzmw7EXkp=4oMJA&%WQJb*!uBmeL5E~RIwB<3yr}|ihqsB=+o=W9RD`;R+t_? zgOVHg+_*>&)70JEZfVxq3(N@^{iRW&nvLzHc_B-}LYmw1wY5@Y_LY-Fo;~W^e0-P^ zbO84GDC-j>N?>rd*USFUS!ivLkhHgL9HOj0+&(r(9H!jqY3diW6;(n(7bCVUGxlS# zb??El;3y6<8QD#~KVzv^qop<&{lY4kqQQM8b5{TuXVn zIcA4FT*BAVi!CW{=AE6ev%)aN?FS=oZ8EeMxhz;`al77WVJ%L5L7d%X6j``S@|k^RNg`;o>4U|BE?>_h=X(x>n-!IiO1_36 zy0ffok7Y^WKB)vGT8ybLC*QLJ&@NV7GYYZaFsSz=ggH^ht;F0b97T2%@JvLR_=`gbXxCFAq&CQES*b?sYFo# zg~CZ|zPCZU+!iiyrx!IyvZ#3XI*T_eNcMNV8+d)ghoE;~s8=LhJcRFDwy#=|o)WYF z7CWya9UU50wS}(n2a|U(d$)yMdh9|h=Lx1Ln<_dtQRT<%j6psxEO_`3DuDRRpDW^* zmdzHB!AQZFfnSQ*Gz>&HmuW28@3b<%^Se7j5 zr1VUkZK}=VVDX#BezkgO;X|b%u~pQwuT*D=PxOazz=Zxz9V3a9a9TGpNhAF}_aQZq zAU;|jPs;L?S@VUVkCUub$MDTVJIS_WK60_66lnp_teuk6^fR-Tw_*ci2XW-7{5ONF zG@ft7PHzusqDa`_cXEU@rbk<@e?6H5$(4$|cr;2XGISqaK%X7FCM`%Zq1pMa1$q3W z@OcNaA}FY#ftrH$S={$8^9}s(D*Y=TK<$%OGix=Xc^=g5-Na=3UkyHhds6PZkEM8m zn0hS|<#+P3-$4R9TUw41A2VU5|g2_Ud)S zJn^TSfv!9Q;w0^JW!59u$qpsU$_4MIe$f}-7#9P-Gh=@+zPc2`Dc;1>>gUY2UzpRH zgfrNd^RLtK-j==;9gxbky-jZ@5x-teg7l7RI5|-Ay!HMv9_kK3h|X5Ne{^N*k?n7S ziX-ezFRi4-Jctrht=6F;*edEg(|pJP`F*{I$WqpU$=zh(L6m^F-XFTn*66Xqdys#f0~Ulxb5Fk+mlVRq$#_*Ceh6_H`mU^9r!{M2mY5{BtC&a~82U~4 zN(3O+AatJB`x6|Nc6Zcnrq@_onQ5#)nde2#hrbR$nm7cxTolBIp#MNE z4+(D{ek;AcPV%~Sw+4DZ?~6qdPhGk9%eu%cxp%UN`ARUpwtR$d>D^XDHkompNoh-g zeXyRKp3;~zh}}C6o2kV(h1A)++0fcgt|zXlpl6>LMVM*f4LS7GrA(!rM`g|JAwH*K z__8+Uh!Ldy#nJaM{&ZVd5NqGU{=h{@%7-4HJS=!c#L^;)<^r6$lI!*Z$=9lPmNd0f z)57LU)Hyyt&G5KHY4Q5vJT2$BDZ?#A+l%a3%Q@b`(>dojkMtf2ZE8L~Koc^GyWvab%f|tQ8N0{F2BA)RWSRS~ADjRk+-J(gtaW z(?Pq%wzfw7=k!md_qDEbCK|F{X8}6SH=LEeE6{idlkgcyrz>AJp|J?+<+9-IJK{k?w8jP;J&g%RhIhUAi0N~E z5Tw+8z9(Hb>!T#S=brHQ$4Fu3A#+JWxr{b+SX=Jjo6y+ zG@DM?<^(Oe!F1uFkrqSlLsG1V?@`@>=LfbM$@m2t1+Y&OkA3Y2w|?HGNQ!LAH=ntq zx@2EKqUQx3P5lrW*QM?w_LJKDQ#bod+LKBs_%rRIZaQdKtbFRgZ)s-MIJ-ATxi&nB zt_Bzg?w{OR%e|+G4X3(7!ZR7#(|?@N4}s$swPkc|IIR=d2zx*AE|Ys+GpXFCTGI#s)+gqYy&kt{sfFT~sy7 zN-C89)x{7qmWg+X>fSxKBfR>uC+c1x0Gk;bf{ zW_ENS)N=Uka5$qsTjc4Se`>|BSM&NQFAFjBF{io4S5_@FL$Yv%Z1K#!Ai5``WHIfJ zfc;mB9B=)E)uLie$0+W;L`+aPBv&K0^oc-(EO;}{=dk_CUYc006O+4H{PP+|COKB~ zlJ_EMEg^emFFO=~PQm?{k~-$3t+g~KrS*|+tw5Q0=_-MqWklI?k-BTPo2C|EXfUO* zFa~ozX(@IsUO!Z0|7mBu#KR60 z4UAliuT4~r;@v9s%ho8~A7gUDsi3gmejCXpFp!CnjXi4p8CHNvRzSWn=4XEDGAZi* zS;X*dM}mbp0K_zv+*10Jzm?CnfJ=J+HTuu;=GF`bF{cM5vmhO@QTT_Jl-d$vrHWNh z+1|1g>D92K7Fag@nNf7GUIbSDM5$9k-Rxn4?6r6cbKnltw_i&>+LWrAB;s z<=#f`#o3Rjdx31lnh}t3C(ih`sCF*K#n*2y5hgXnWO8l~JvYQ+`93^OHmg z_v;ZmhhhW;?i_jEiFBUD)&fbPBC0}e9h;@f;T)~-hJy)%gmzkaS~xWDi}VAt*kN0y zW|5$JDnElJt0>YDH`EcY=+*M*f7wA_oDFD4Y~4a)-E&)6aYHoM8-vY>2z$~$`dF2t zaUO@M&72}tI1Xo^soC?uP`4JErVs53w6mAH$Vk>Egdnq-Teo9viE3qK4q@$}z72$K zz8K%2OT?k;nHq=v2NZ{)3|Av*^P!S_{FjS(=$r5AcUDfDtw$v?{P*7+afkcY`(8$y=zMi)k|LZ1@gne~lpl(8+2gnzz+|248@KVgt2 z7XI*1UFdzBDi2=Up|UxB{R|n0PnfKx_A<)$L~U zl!Z(egQTeM(IgdyWfsyG@DMCJI0T;6pNOz5i8|AIudkY1*-5CU0_}>SoRWP#@OC_q zxMQ093tE1^y_ODCIPHBIzcnfMlEsCS2eXIJKE$wujp<6Hu6+7-;NJWmhBD$g%DdNJ zDzt0?`(j33wZkB-83A~1kj=fLw0z#qOeUu0rzMd5GLC>7;Hj~?Z*JG~etUh@ zzrDUG;PoNCa!ba0({9Or#Z!rWNKNf{i#(I>NK2>a=6Ep@5Gwk)MRh}O15g}cr`~!Z2uTpxK#FV(qymR z?Sv@25`0=3hrmDBC9}P)pBKcKLTj*vT;}iRZQMt5XOfOfYi6GSmC7s;uiwj7RZ{I^ zTP4!{Vp$BgIWTToQ_EFmSQ&kF?(SSIcX&ETOaP9o&l-Qr5n2M*U8j1^+z~`=-*-Vq zcxlso_R-go!A$pdcM6A260;*vl6~OXkl(@-pr%{*gC2H;uOR&4dI~Z+VS7Fkh!iM6 z#qg1G=TGFO_$nr^4vxr|ExSTh;w`xfL%ddDK?NqTy!KpM3l^D}ZN;D7$ zV1=pTunF$HJdDNbgiVYEoL1QJP8y=cqYs^kL@8t}i+ZWA?y7Y~4aVkI1_v31mzLI< zjPQ&XW%rBwRdXkLXL1-FD8O{0E#J!>JqyH>xV3BzWchpTXRi8;1)5EfRM0W#+Jy-L zjjaTI;B{}Bz*Q+_7q!<0q_+p)c7ydPPGhq@v@#YbGbNK7Q@$M5^lOJFDL7R-o$ep` zp8SUS$mRRt2Aqe>tQO|PZsxosU-AU($L$_-e*wTUj!kc_t)|zzbNT#=GCBT0DHV3c-YV6AV%mJjKJ*OJbHhkPz{Bis7^`V z#;G1a{JnX$eWvKqtz8>_F^e7UgWx?v5IqX4{-Yse$+z2+Qb zv-DVM&_{j&8tg9L+Mmk4%}c})&&ZN zMCOdsOS;h=&-R_2H=w!LODj^$c54p`5^bawVHK##^ ztZd$BH#cN!R%szy%y1qNF+l$y{)_%m8}oYr5>uPh16~8OCox>CnrDX2!tx7@3O$Bf z8PkCa&qQ0q4^hLt8lM-2BY7ahaHcy}E2$MTs^WtKATZSx2k-G^EFI!;+C2R+`oFXQ{<7+%CIh%MQ~eML zQhLnG3r&Z|WM}tXn7Qt%Kfg>%XUU`w{Qgdi{;ioU(Y=dTIaNbht@478?b|8VCwbnc zlWJJ*3eRP{KV5oUnShS+xBnBjlMlaVJ<;0TT!;#=(}6?S&E{~D)}^+{y+sjRQv!=0 zUeYxO%IhG*@>Z4O{;R+n7q^patM5o~G(>1fpWGkwD`q{6Hw1F2O3!p}E=f;u|9w5* zP?e8LK<3=}cjlbzTvX;`&~;52W9=m82iX+MX;>q1i%g*l8z%0-|8W<23za1Sgpy0p ziC&5uFj(LKqJ~+)Ur|1V#%+ zVkW+LOMSW`-|R1je`(R;a!Em2Tukaj8nV}GK*ham3MT|XSxwL7Tsexzuv@4}_Rw9U zmROdj&4GLQs&hch^~e;@rZFBFY!})LRh-IGI4ZE&tb%>+%dNiR`+(H_J2&$-w+Jw) zUraY=o-L*3!PmM@~7+T^LacjxnC*_rMO z>ezat^w|f# z)_=N~8vLN4hGV~7a5k^}@PW-bwI&&U44~X1sgCxXypdgR6`=KwYU!y;M^nH-ow@yi zl4*in#nzXrJAnEq`!^G)5X~E+Y-CvGc5AjKJl~RoX-kx-k>ahHR)&MKEq2ty@ z_k2i~KH(InHw(Dv?eYDU(p9XSZ)9sg;}uwerv3pTq75FrMq*=slg_0ny8h7Q$#zp9 z_9_OrCTB4MT^0ajAjp*P(M|7HyxcL4(r6RR*B7LX-n zcbKqW?xE1yorqAhFTKKgL_q{|zn^M~ts5{baeS9DU3crsYSXx{IZ~iTwJ>s*7sYs3N`2K{g#q`n*tahg)n&oX@%Mjt&d~r!| zUI5ogfXeIgGrEZHe4^4G7qM)XJ3xCO8WyOMz{2z!*_*3ih^QHcfM!I%ZL$6Fe>0Nx zQolZA{~bbRE{L0%ehB>PaCbMSUZwvQDK2H!YH`17JG3Zh$vvm?d%k%7MT_t5=SGwV z$NRF}K^E089bfkK+@`#=zBdspQF&$G_La~^n3r)8?Ti8Fn_c1jUm?bS6`KGV;lW8I)rdu zfCnccD9*%wPimwDatc>p%&t_Oj1Fy*VX_eIs6NjJC@6n|C)91vgr`U{^VPmEs4}0l z##kp!Z%Fpr*#qFG7n@HldDuR;4or>tu1R{}3h1I;i;w10xORFeIemf%L9UDt`7cL1 zJPCtkc3T}jSS&BM8hd<`Pf)QxUtNnkw$#|!yA8=5rN{oI<@_zD185LlRCE49cbdHI z@**?33Soh!cajJkCu`KZwa-bEpI+S;F{YjKLAvIr_(7ALpm&xvn4Ls~{VBJD=jm1P z8h{q*uQWc&-WJn__`6GVc%k;vShPFoa{(xyWnEW;E?!?>+QAwn)dKLlswQbmUsAil z3G@8-fcDCkX_Ai=)oWh78O0M4Ldo}rX4d&VDd70v<6l-o^6O&<;@zBHJ-*3Hi?S$I zhQHbg@k9fz*W&S>&poJ9O}p@~7ZS50N1|*@9MpD(9}$F!OtfDJlyMGd#~plK##= zFxT$E34chS+>J)#JAqNUA+9`8nqw-9kThwv&RtcLFgFQR@g=ki+`(cS_SvGWYZ%7a z+n$-k4g8>s$kStY{w|9WDpW{-#!k)ZGvCg+d7Ny&kds!Y0FYWJBr2qXrpYAVR`zr} zdTy(~e@`0rx@~N{Yh7POMn{~K^wXY$|L3GeMxi!Ysp8`#Y0fqq7~znS>ysU=l0Y68 ziMX34FX7U4dC%il#{R2U#?`Nl^yr{X>@rX1yQ#{a${ItglQs|l0r2a&am2A=Q z83X{bJvoDc2fQpyoQxp3J{8qT`j!UZMw=%9E55JHiuWO#ditA|lT8{Z-`|!Bs^@9k zMPKyFs*Yvi54wwbu7SZOlltXUF=4AcK`-Nj^W012N~2rl!>Z_&9HplrBPpw{W@rGf zIUKoDo`Lt)L|)ASUHH$Jk2v#u4T|oatc~$+)N`BR)yso~#0U-OZpj&MB>Aw}0LI%* zm()7^$rtywgN0GTK89TCQZGxCi=k#*V%m72&Tf%M{+^31uXn)D0V+~v$YyonV~0;~ zVP#$oGk&_Y`SlM~TclL*Q=3mlet8VaqHdbawVzIl)jai*x+grBX#)i+bZ9rMW}lg8 zh#MMIE^PQY3k3K1$!K98SVk4+TvxkVOyA0+tvYE=>~|y6?`4dgEFHmJr!-Nfvh zQU}i1P2wE19rTAsiDfPhjU$)}cis5PwA4OudGV2!j*_&7Tt5yx+cx6y-42|XIOT8M zE|})m$4jAD7ByS49>2s{zBIb4Y0)P9A&2X%r7XzajE5*lJ6u-Zei>jTcTTeETjYjf+Q<#!R7+wH1WEf)C{Ux>GSOG|T z(io(iI6yIfq~D41fPf}>nqFP;fGE{VQQ3QclGf|aj82x?6%cy0wCJHECdw{(Ikg7c zHr-}pAr8mzyrry{q;%=5$#zM$2g%+Y#4q(wN6NlvsP_-WU_b3SzO}c{%i^Pxg2x5E z^+HmU|JIG+i2381j_;)?E#Q`9J~K1nEw`Cm;9EBc``3o*HYBdRZx*?iR-Uzb&%?h6 zhe~HMN9lTdN2~BofQN5899pbP+&()3GQ57Vz(?G&pm5-7Xo&bE^M7$wfU5nEcPjuT zD)PvZ|M%ZwAz!b^B`t;OG%UM!8=eAa4bPCDjNIs&jOmNlk!7xz{B7x$8iIqIcBzp8 z^b_^SFINJWg%$(Bs+CdU{+{BPB0IYbn2kYMzjsC$tHVd=wp$%EO^vMTis?W}4ww0- zo0y&C0 zNqR>VlxeDPFjA&B%){b1ITtR_<>1qL%z*RKbMohxdA=tnFO(HNt**T}pUx$Vd|37) zuI%3_YiYNbn5;V#UjG&%5Y7lLxJb76QdyQCo589fD9LMY`z*23Y_P7;s8k`+K(@R6 zvM*!fDn?4!>c^)jTi3+SSL@XUP(E>R*!P??gH2OnS=D~ry=Oykh3l8lsmPQW!^W3P@HLehe zWxrVz|8G}7zh69C!T28v3V$2LG>b#LEJZ zM@aa^^?$=u|Kq{``KkZe)&FPsfSdh~0snPM{&QCUrW{I5*JZCnBT*%|J_>y5nbys(ExFOZqV?N>QO3MlhvYO11gDZ*~5cRK(`yyBW*CwQVtW6XwB#Yok+30WR?Sm-P?Cci4}{ zh7jpncr_7Ko{>JD1wZ96ul)5v6>dIMg>GHjQC9fi5aKfVUW!ewb=1a2)%!D~^2Gr_ zengoE@UmBc$9`-82>nn5cij`;LrTHT1@b}v{UAr&{gae5QP+6zd{Z3QsvoYFFIA}2Oo!YKFJmy8gObasa%%5ykX$GqPIii~v)+1i`Sb(oC}Fa= zHW=g)mwbxvu=x#_hmqplO;3Mwo!_OH?XzpPSF|fVU`egp_bWKKZ9kPVm<<)?etJCuue&bb>Z@zQ1t(gWZflfY{5g zKtan6pV|YqjEwpz^QoOCcg3+b->7k_;T^|vYUfPxKy?*SV5VTKP*a3l>M#+2?7Sln z=RHWzz5dNHyuUUz2S+_j!Ga!Sf%aUu0vnh#vcb)BDeD7PUKdo|=^ z!YxfkpT!hZdhqPH z`+I!7dCTW!bXNEPg(_cClQgGWan~WKLj34NU6YuO%*EMKkUCzqLbx;Nf|Y8BD#hYQ zrq8^k_N)q#(&`UQ0RS6K^?`s2b{hJ?&u;U42f;MOHhn{O9eT~WX1`sM@X+WDd~^S@^dxAe2#B7~+tVro9z zZ9J>60Z61z0U(2+-oTi@?YN~MzNwRJv@j$^b+?#<)$1Qex=898pi~p_GQ+XSK;uQj z9HhIaX9XY*Mz5OGIfBiD&~kG_+){@>=!1jTlm@{JtGX;A)@)!EJQ-gL9 zzsI?M7~kz8N5TACz>{^#LTip6=m-&=HYt#*MdY4wJq@ai{n$Ka?SHD)@($Mp3O5xttUb+eP z>8Z)YPiO%R!}Q->d|)`Jpu#rG4n6!dTD8{gFYQQocP4=*kYq8mt4@L9pfh? zj+&g?7tV00)-O4H%#`1umnPqMxo>{7+zsnaQ@$^TDoa>(Dp$&jGg=Md36X^fJHsyT zOXAj!oCOc}Ysbh;y62R+DZmhnr~GIIN5v7q8;y8qxd})Lh$ZV%2$C%Zk=G`l6t9NJ zNAy>=%v^%69yK#*uK`{&;#m}t5-s%^z~F4^%vpC;WPFHu-xtAC&5X`R+MaQxs;tAO z$*eM5;F!bF4(D%R>JnX@SpmL5403m7=@Y{h%xWKitw$XZ zyVRBjBVN=5TY%bxu;%j<+02+rHBYJCX}|^Q7N|V|?iZ{RcCVvoASDsDw^JcX)Rx8l zJInzTO~1=HWQa^-$_Q?|`dQ6PHu~s=J@GU-dZpnWW#Ty1v2nJiSz| z1SPUOR?#LVS8IUA5cwe$5K?K{9Piii8M$rMC4O#s(ZJ2`(y(L`^{{Y)EBrbms?8*H znyMJ(3qV9SU|Mpj<%blu~lrJ$2@<^y(mfyrW9Y1I{w<8a}=5^ko}A4 zMNebo?5p1iVS9v)(Z_wE!Id^S4SCgcuHZIw#W7(Im)r_v&xET*0U`B zy+eWQCBkL@=v<9c>ay?nV5HW3DhSh+@&B@bmXR zU{i*sc*XTP`r+P<1d@#x=Y8FG!QRBxh#I@QBbz$r#6{N#%_?<8-$5 z=4)P4CC}R5z^R{@r`W$K$JC<;wo!)0GhRv}!AvW1tk2t&al-?H?U_ScX%pbtJM+!k z?W1ld?y!*e#ax$slCb%5%>&FQ-ND3<#0}x*0B)ODJE`oZcQ|9^ycu0w7aVqz@K+Dh zjKS}`xTB+Tc$xis+GqBYK$aAZ{bFU<$b zhy{}R19_Ep~HlJ~TGUS>~Ty)mwnQ@!xvOp>Ry=EP$K@iO|N zKku91R}lsnVYGdG$oP^P*JXVN_#L5R?6dj;ugVFBNDIAF@43A;{|5oRUsKho$R5P{ zd^LSSnA`h=)4NP@Sb#P{`;iG%cvM(H;+(=!+gEX_4*sB6o}HHk-{Z@Y+2X$>{mNk# zd!lH{a9U8?7)#<{dyouE<{I`sqvml$R*y=OOP9!QW(7a%pr1J4K9Yj|Fuf7}!n~8d zpt!W@5F+V+f)bKlg9gYQylg+d)BA!fQ|*P+eIm2(V5U^4fMDa5Nl!fzW|;HhaPY6_El{}qW23EeCGa!rxD0UIK)&- z6S!!i*o>6yr+L@-^ku^#XEsMQZ#=n5cNfX8ba3NH&MVkh`AndLIpV7q6@Bgq_TC#g z6VD!HNf{eW^!_oL%l6JUic}rX(qEkEGI=&4vfJutwp?zxNg|-{11+1J;HgV*`^=*a zfZlEKI8FQJH@5`aAZPwGNc}$@WT_Q6%XI;lA1KPlm`ynBD>r_TjeOXqRH?^-D7Ji^ z9iR+!GQ6^C!4G%aJHW5b-|z#+v8a)%8mhfbL(#Fh`;9Xn!rBi{@BlUSstZgn94hY|ord`x2<#P3U(C z74-v(oQ-6~PZwX}QmS53a!8M*cy7XhXhQbOV_P}^Oivd7>Zj!<6>9vZIp^j6hLrnN zFT3;RS=x!aJ`Uv{-Lc^@kJFNH-|sU&zd4F?w9X|b*F@~6t$pUf0Z!A?bNB%4bwPwd z$DtKz3&1~auS3JQTbO!WZWa*dxDiEs=tu&Z1f`l^H3ky;Yq`j@1VF~{FnF`9eXm8e6 zlB;_$qt{TwA|%tXW2rhZ?C5JYUU{gz{gaWOx5%#;evB&h7yGZsyu9RNsU*5IlEauk zsyocNoFW_-9sPrd)_6))uXpwExz?`*14eHS<%o={wqI2wB5rM8BHt2ZZ8@)j&Z@qK%eb>s zIsPU+(eaS(Pv{`%fKU)=5B70*x#P-+y_6~bB`bCwFeCQVw&LZ6Fw-)t+GvGadOw;B zy&x0!cKqU=S*j&wc-OmU8K&55^0WW07_I=`NtRNQ)v%sN^w0IrpPsCFY}l8rx!06g zH6C`zFHBw74I(WBYMuA}`D}DEOeC-WxrIcEUEZtYRpuQV<&mLJk>$EuyPNl(@2=_m`)y zs`LilVlI$*HgLVQScyc|G0pSx^z?xzq3mV!aD(nb4|L0;y(@z;MA0T1OfrslVvjZWQa}OX?(Q?olSY*=o=)w zD~eUUYd~4lM(k`Q(sgp;XvOx>FcF7%Fmb1Vk&##;&tqFqIQn?jS?++hsVY=f&JZXn zXc0`u5erhp@sZb=smhZ&B#-CH_uM7Rc}X$CQyQV>zS`JEs`hT;fO}~p@tH3DY8kd$ zu%+ik31H--{63T>O&&!g*3G>?TH#UZY)3NR7VJMHLvW)ERRB<$1OR7aDPr!i&%S+i z&Hfh7afX+-VDm-D)`#Nx2c-OF{=Vlxap}_m4U%J8de+v?7&mk(FAsm&6&ax!06y>2 ztL)a!w?Buppme&;(X>jp@BVoBn;Q9ZJF;oTz3Z0ThnE)m0vH~-FI>1L*15Ad+V;3u zqV)3%S8gIT853%2j_s)|G+6bvE>f&+li}q~xk$-<#u4pVv0@0mc+9!O~4{KiHL-3;%ZW zLvQ22A+FGpV#KA2J5DxU6}ksrRjE|m4k#7f9%mQisitxiD!fH?Yp8TT$f0c3AJ&nt zaJ^(^3;E?%nDFBu@}Aha)I(kNXJR+5gkCsIHim~UUlPRXF($e9f8MmKscYq7ni~hF zWfcq_kDlqf>srVbgY5lH!IZxOreFU;ei5*Qg%&Ot`vkZBuSZ?A>vgMXD;YB6OaY_x zF6e=kial?8&v>ef8N5+>Pr6)j5rgyf1z{U)~*UIw4 z=RUx8$TmxTSCWw$l6$>1$J(dz4KSh7-FnFryT5)N?|ynP$f zE!Jn6$cFj4;(5PtU^(|PuE@;aoOAtk zdBC?8ZWBdjEAaf8VC<*`5{wEMq3xa+$5;=wiy00i4*$UX`_E9qkrK!<`t!2rF)Ype z!Pup$nArSFF62DZsX{`;bavPLp<*&9ut07>wP=mVY45;6pYtPh&`e?4J;QZGRP0JQ!Nrv1<7 zz6XjC{`b=VZSOx$*#B2SI!>vt^^MJQJ$rU~I%^{G&tu`2FqQnSi0BuFDZT&j|=GUYGcf zA8eAql+n!MQq^BSxGs_EdhrS)l``1j;XjD{d!>xN5}8*3Iw-aN+fpgR2naJ~a^-=$ zpWhyuLrF*^6W!b)b>lym0j$bz<_4p$h6t=Z?%!YZPg0}*07y{N8GZE64ga@4Q4s+s z56b2gy!G4LBvRD?5;RHK=_LPy=s))$NE)DgbCB8m?eE*E5d@GRXJnfGUnt)MC}&GX z%qje`ljkJJos+;?U`_cu<&S`|zB1p{V-rdK3km;Y-v8Ci(|qd73tJGWogTGCUhPj+ zQWQ4DI_siR#Bf|5>*&DUwPF%}o2?Xn`@_2l0%x`m{h}B?OC7XOg{3t{sNfBRFFyrF z*ZJFtAiNkPnJRZFoN{o{#@?Able0uG9T<{PgSu#kI?C64Dk2;thYD0h=hY@oIQ93#x?pI1 z?;6^93?=S21unr1Y@kC9%j986{XB@qUy=!qaqEbg&KTTw2~aM+WpgjWeKp0?YnC&U zBCpfFCN}xZq)rq+twSfayJw-!p=TTq@DFpS{c-z0P7j=3&skr01vI~)B zYB~t?Fg&dEiFdDC=?#HvMhfMkPG!$L#Hv!f6P666!rJhQom@; z)N(-8CXP&_8d5%s)V{=haQ2y;qn5Pt+nzBO&(=ld7<3&vStZ||lF{RK-9!$KI(LRJ zjE%^az0F-xE)sLNK35JU65&XCHQ*AQ$`is!M@kj_rl+4z6Q688l%14a;6XI-M3Fq-m#;P$kXfopMnw zH+HH|TkNZ77z~G)VEY`LvcQnC*jQ0vPgvnvvlo)G((&Hd^DKzIU}6jTg9gj@o47}* z`4U82sGaNky4x$9{&bN7H}r#IeQ0=jxNx7b^^^EnY0~BT&wW&!vy9^xiOW8O8Vm}x z_ndJN$y~U1+>yNh`qQLoVA!%)4x_S&MI@!f^2Aq5seG>0sfmGFoue3X>wF%=&MTZr zB}eYgQ^OFGyKOg6KCe?e#RZ{<{J0`3(gxMvOiJo8ktCIb`{`R~fow~JBO^zZ^`V8O zvJY=}cjH-bLA+I58RkcRjf7JArzx4?Xt^);O(%wC{IWdpU4jImB9lC6AQ0OJ#?H-t*Qo53)-<@JW z$6qD|do;E-Fw$oj_GcN6&*>RPz3+5JwNI6lH zB1?tE3lyJvxNwVF@gi8n?i!;+x8dR$gR?Csh*1OwZH57slo7hBlf6DX0V*heF@dvaYMWp%es}MX%{WQj#nL=rSD#X%ud@-e zXmYZCGH!6pD>@mmplL?1gy-_97+BkXRVzycQ}$S{yO(7$Y$V$uo?&CQY_lL=NzgwZ z04s$GSS`@VdklVb(MvgTkfLd%3&V60kDMy*diAv!qSMzyl=QTju;fB^E#;PVznKQV zQnKq3q$`7Y3y0>7ik$(Jk7IT<;6}V@IwLa=p?>da%qQ@1^~Y}RDl+gmgZi8*K-FMp2%W zF*kE))B`5N5xMgUp0MVL4=C3?a?!&auGUzHG9PHk=UVb$GdUcQBnjvRTtOl*wDEU2 zaRz)J5@%AGx&yqe&7*@99w~Eq9g%payz3gp?N=l0WRcCPsftd-ABiiU)xL z_L9{yil4ZH7L_0E>ba>pS6+aKKZu}|2&#Iph5Qi4^rNS^p3{px(Zq@bKlZ&o-IB>C z!Lrt1M{3M-RWH3rv#3&G%*o()b2v&I#OCW11BvS|R_eOR=UzS6u^A&asue%GMMzF3 z+V!DYwZXs(d0;-Hs9;h*9Uv1k6bse^=wP zgW)iq4|PSrBCrD~Ju<1QVa$_l+^TMFL^4&4$Mu+vaTm+l)kYU-bgeu@`0&HE)$|*Y z{RE0**&EW_RIZ%x#bI?rQwn#EC{|f@zZ%c!>v3A;h*cF zqvJeQE;+c&k{Gk<1{FArbGWOiHy%RjQ)2U*}$9B!^)JD5|$GSKIDu@0HBQ$}`w^a`6H-5@+9yJT+b31k_!{ zJ^F+!19OjvL1y@T2TXzE%S_X?d1JNMQrGruV&FJJSEK~>IG{r{h4K>*v$I(0hlz{` zmZ}rPO7|M$zEne|PS}xS~DTkySJTyMZAc&Ik zubqwFp;iMuxhElKrI|4-y@y|oh*3GrV+lZu+8#%htaJN1?cv17hLkfIQYvAMXsvPM z4hF|nDb#m`rb+~o3xc--{%Pk}dQn%I^@n!QNw|NT7eYLa!O5f#f0s5?r(l~;OZ)v; zd?!5@zQ7#1xzDdWMrnuCFcqzFgUylyLu@i`fuJHa)Zntk$QR4qwT-|#B*hg4M6|Y7 zC-^yZ(wAhJEqAyZ$6uqO6~N^SU1#WXYlzutz9P=P3J@Z+8FPQPyO_ihx%mAOCqwTk z2K5odFS^&h|4CoY+n*a4msLJmx$0JQsGHj+T4`{l{bs`~AtscGf@A zN+DRHS3Ka2#oEmQo(0HTL@eHcquP_zmOvKG+Rl!8eIE$lvw}zF=VV5KuCQ8A$G8$K_0*7A z_sCCl+~(laXIXN?R%nMl&f`)_g`2Yd;hXU~<}GNnBlv>*m=))NAn|X(CYymTLI0Zp z|FdJ`s`?$TVNT=G#b_M1KvY;qH1;gJe7DvJ8NCDUnIU`tor`41 z8fmYhctY$`8ttJp*9Y)Oy&w~xYvW-)j?eYl92hJ&Evr{S)#isTM%|Ff z|47ikqwAv^>&^9W4e=5(Z+=*X)Sr2w@cWKDC3_rA_@JWM?WlkCW?vKv`_)Bibap+g zeJoxYQ(d{%I~Y1r2?vy&fW7d6(p^5IEX-1b3A?zej?<^?wf=7Bi2{EzQm;g90$HkC zPV@i50>CNndxe6x7JEO<4=u|uML`?7J7S__geO)z8IY4?XC+uniRjYS6E8ul_>{!m z94+a9U2Efn!iorvGKH~%MM*V+rP1xG5-r7L6V60qxk?db?Ak!z?pPiylrIiwJo!cW z%-_g~Ak5fGw6h!rZ|uED;PomzS$O+Y&I*(99IBUT1XU-C~EI$%slm`!;=4NT}At)=_~Qe|v>o{3iC;LOq{1$CO<-62!N?j?hjv z?)?d)ZQ?YTs58+6qDC#xr$xUdPEy~V=QysLnA!kvJ{cV%$;>6Ixjb0i6f#5PVsbXM zW>sSGLBz8MyMe!u@lEYKFGQ+=@28beOS6ToLmJfRJ<)OiuEF6I22~ZzXIu9+rIqQ|oxY+Gah{5K3;)^08A6z0`$MtHi_1g!vwhM6 z`AXV5{&N2OVfnvA8@v^_#0s;K$4*L15XA zA_NjkzmY*%4v_J-@E!$_;QsZiI$J72Qc#2um10a|G&3Xe7@-=H1=K!*?lF*L0pam9*a6$U~^{kV7+ zS7<7Vu#IzcGy6m3Gm(0hQW-GNN(f9(`SIty(ZV4!a&)D3RqMQYPn@x#*GWjoJsz<`pRK4|EnpY|WT>>J z!uhOd@@o>G)gYri_}{HtarwE6xCB6=m9ivzKhey-yxtf9ty66q#AUFM(QuYW9vNKk z0=XpdJFk4c%*?TyqNonJj2X;X%rdK)w>mXHGLw!Ynml{fq3_hTJgECs4V3z6|CHsZ zQExrax$cM)tyjgF#B=Q}tGvS07~OjD=ky;^M@8WL7_eCN*-hb?{m{0vYBQ441SZMyZX2 z{_SYU!zEOS!#NQ(`dR1#UOvrvW<_H`(Uoo%3GH`2`tr+ClbBouLS)bx~(IJtcVPpwJLaT!qchIPGAOxld=J zsj+@=#z7%f9+y>9c}u0}vHZP%*S+6JC>04T`!iVi7yEHf+3+)jCj|x=p*sU77l~vH z-nKme)Q>EiJgQu`@OwvdZs(ctgpcX+oP)9)cfUC*)E1VXGrQ>V&8v z6p1Y9yM!AB7X8}r+R?E0UBR*Cp=G6h`UtD}ae`5^2r-w$dFI-4CX zurQS5Dh zMRk^_D)Il#Fo5rGA78zk6gcaDCfgM z>WzvXdy6wTOd0ffu%a7wY8>|JgAtDl*C*D|)i%MI9C_(niRlyarN>9>{(a`(9?})r zE|b!oS(9&%yYiDr zKd)SW4|ph%4LKo_a#pTKM2kK9!Gv>-j3+_7f8mL}>Y|JG1 z@O_OBg+qJykoyYO&>N}q@_B}F=(FAiSW{*KFb>eT;o;A-j9H2@AesKq_%xq0Wsr=k zF|K0G>DWBcU13bIYr|G*1nwdhUcw=MpB4LQ8Pt}&Eyo7J0!31t)uUweQLj99zS!^j zlkGE8VS3q`Z2R4;+>&sPoB>*uX;XvUUhdLOvHMR+MKG?&vr>b1i1zx_GfPua>X=N5 z=2`XR6kv)ZUkSy0ULSReGskr*U(MHcy$9y+^QC)`?pHStNg@-kH5`8!6w~Aas$)EU zc=J7PbDAj$80%o?>;6*2h^fCOa*sHg$BZ-C?ya5+oIhW>sQh@zoV>Hrg13I1Rhp$C zy9}Pe*anQqq$aj0<4B)s^E+Biep36#)u;Tl2`WI43E--j_lPt;(gBY$EwK{7y2xEd z7<@WEC4Enewd&i!7L4Zh49j0ig2MDuyJ^;QdouI640)^HrC=HOel~w=LP>EA(c6ZB zT{g>C3q@~_FmOY{RlbxKDexHn$N*sQtv$Z1W*go;yQ`L zwy&4#J?5FQ2;UQj&F`)ufBBLsk^p9~?@pr!gDl1=#jf+dD)K$|0kkmT1NYBJUeW|m zy8em{Wkn*F6-Sxf^rWQ#8X;TPi+O!C{1n7LUTJg1GeQfqGhAedI_VG}xRgAJTCN>u zqwP4UBDs|gJ(LL9Rj=Jm<3gkH%LaMWGKbNJrTM2^uuo&zpq3nbCs(6_41I7YF43Ds zs*(3-d%zfok-5%DUmQSlOclQr=nq`3)mOJF3AZJ&)u2q=;9zz7&f4^c( zt*<0U@`IEHDbi+5dvguUe~o3dt&n&KK$M8%SLCo7M7(@X(x|+8cI>F6INw2w1C@%L z4wCh`TirxHFCi)$JhorWvA- zPt|&CMLr)U%Q2%QIQ`LX=w?c61;z0PKF=db&MIAt)Wf3rWd)994W~lnP{AE~b2Wlo zk+$o@%HtE0E4bUoM|!Z43|ZrZX`(AuvU9;8KfLhCv$Lo8#oDh2Btoaau)I;*!ioUf zz#N=<$}J?SkiLRZgIn8leBV$VHk>z~##sC|IDnzlb|-G8Dh{WbB1>wJKOe}or6KSd zOk)L`k>{fMriIHY)_DKCx;_ItPtNEs&YhDS>f*!X#G&n^`t7v&xpt4JD}~t+nzRWUVG#~ z{9#9D_ddm_J2(=1u>Kv2Xlkc+Tn^s}KE8w1r^Lwk8=4H!V|U6fnJR>7Yu=sm_sFUCdxcP+VuPHBxl}c@3q|8lQK>3_ld22V1=3-AL&*=- z<|sYhn6>(vo*;K7UuB)_y%wDV@!N&J4glTpCrst`%`hEQv<7fClwf=PiXAW;hSS(x zc&&|5?OGk2x-0*^02}BzrjPeca-%HCcFaEcvbN317(8w5PEkz^v6XIGT59umn&dm8 zC~+%Qo^P1j$QP2BCsAbiYcubc5jIZ7>9Z<*MXSpcR9pvh68-ifwblObh_0~Q^^l>w z*jqUWUR&K0D`iRXW*sXp^ke4|<9JQ_!$?fJV^4A!KY?1x!Q*L?$ZH34WFAw~**m<;6J_fL zd00t5`PH)p^qOMD!T?{fBsL`7RQ@o#4wfpU=G#1Jjk~1b_X4J?uBx&WBfM6YA{82F zfJ<>D$gMjUze0kDUHF03jTya4xSH;$;l0lR7~9sd z5MC*-dpVCj(q01{PDK_5mWDP{UlN0@-t(Fx97dRK4^}Xtai{Cui??~twwg}Tv8O2j z4=gkJHqh;Ooe6@7iFc)>de3aCPu=^>1BqlC8XV|fifub_WkBKY$}L)ZWk_TA9UQ$N!lg4S&T8)zeGS zu693drTsoRj&qeXz&_iod9i2Mp+N?ig0X_pv7-2Wog0J?=7kX_g_4bj%UQPH+_JNY zc)YU_Uu$OK_0%w0?oN~a&Z8w&DM`abvQ0^4n2)bE>EPUUUlRiQuR1bJ)Z0& z_{q=;Oc%i+3Qum=YZQj1Q%p|w$cY-b_6_9{wBWVL73kC7l3BTJO^5fSC8T7m3Gje} z{T!*W9cnZ!CwuLk5Dhf~%iTml)l&{1iH^q1uT8U(ZlO-yY)1EDdY}6d3~71-kVUET zg^Cq2f$J}~Jt2w4VM0IW^{j49dJXb*yOi{Ir6OR5H-*@*&@7DiJ*D+u;S{*&p1=pH z)fc8$BfQ(_UD>uZ+$7BzJNT~9G&acQ=a8HNN>0Zlom%encos-m-FvAcUPB}^inv+7 zv#ht9hI^5lwkCgg7eLkJXvjnp9<7-rIFEe;=$e=nLq}bcCJb}Uj|;lOn9CmFP`l*i z{Fcm)c|N;ly@_QdvZo;^lvVHBOCIE#aG}1t%AN$W!TVDlmER#X->}{u>k)@{H;}o^ zXgufj1wGio5+Zr55-dvE3tK6+8SFszuy>_b`b_w;tK}y;E(EHoi0~P0Mgs8lKg9MI z%LeDHlZ6UPos8JmCkr;*QBQK__2~C5yi`-w);kH&lwF?LM;ZFmFt~7rzEzqI6P884 zq5Ug*kr=w3vjrp?>o%AQlibEiRNp|98NBaw4||GT-D=fi%+(9??i-?6%I6dopUrAr zXQ`9bNR`C+Xf#9HY^_fan{5Een9arjHE=_y^YhqU&ix3DLFjy)U$Bk)42Nqowaih? z`@SRr47cSi=drj8X;ZqMC$0YP0*x>xWEB2|2-cOAh}&)Qw;yO+&zqQ`mfD<;Fvy2> zv6}1O?ota^5b)YmQzMWiWMk&jYInW>cOz~7q(82fm5H;Nd-v+=JDbpJ;;sxF$*O~I zR)8U4VOarwG8J!YzrhkzRg>?|Bipr(J(#^6-LuIkyzqE|J}cq9CC#kXrqNy9{vCbT z^@S(ug`CV<%4~+-qT|HX)R>ZmKe)_E0w8&n-fRB38)t@k9Kv|4!IcOS1 z!r-;F?yB;K{=+3V*YpSuiyO}5$lYn=yi$C(AUOfrU8CU~VJ&RqV5U zhyWto;eM_O9lR)mKy8FrroB44F^iYkX~YP9uM%2h6PTYr^cKXG^XTWC-kbMug24&} zCY&kzvKjUkGC-hkD>9v{3$y5M^*Jj>VN=V0W;$_B^dFgr}#pjuljx332Eg~lZPFeBjBQCE&F7STF*>iF1F_XOPg zF@iS9;fws2_1Z@P$PdrQ?A$A{M(i9Z0bJ-(qu{0uublaM^TM8i4Ft&r9;(fAhRz<0 zMRc=>tnZsUjeO_O3ogijJ|+K4ou}Fn158}f+=Fa6au&T0vT=7AamHO;iZyUU{y^B! zvdJFkH8U#TmQcHiZnC*p)*rKh!dj!dE4qNQc%b#X!!jcwSD(34^~u!u0H%1IJnef6 zftpXOiC&8UOLQ=2y_j5167BfG*U$6LpQ#a9nX<^Xr$TA6M9U} z-`VziO3dElAlnm(*kN9MX3ddJNbFfykzv}xnND>_BJX3PZcX7{hGSpO=LU%N$Xhj% zk)9PF`|_ZzN4ZC=f8PbAE|Y025%eFtD^#Fc%E?%kp(SC}3uifgqu=k`axneTcC?b7 zlflOTI17_jQh{H3L~$AWoc#s?92U)MF5j<9xE~Bvt@_7K$_N{ty%4CQ)$9r@&5~&M z$0jeBXWy$gt-PzO4R(Q8(ba(3Gx%?NM68qRRT8LG61=h&xWhFIrlWf0zP);Fd}D?o z>t=eJcK;%j_B)(6Qv^1(x?L06<5Z)?3)277kq*!I2ClUpAg2qdI>|Vd)xOLL@@lc) zBG#Q1{CR%g^=d-9`r<%CrgpWVXl%9=cn9tj^u%|rN0%uWW54$@x9M{8u&8&Oby$N( z&O+?qGSAg9Z4-jrKTgf&5ff!ewYID|sc20bUxErC7om_RKQ)Z0{8=e9@OM5hFI*y; zoN>tvSDJ6b##a$R32}8WEG2f!s$QeJz}fH+qyW@EFh5HvZ6;-Zl^$<7dM=kq=W>}~ z>GhS%(kY7_{0DUM1@7h^u0i<=Xy}5>Wa$1ATG38D$d~O9ftAIrMc%4tZL35p);Y%y zQGC9X3kitSv)oLZ%*a1CuKzNF*D|6~lrAajgU)*KgwSb}qZq$+FJroJwxLmTYkS|K z+~gVe)8(0T+(>LOJ~Aa{wWJO44&}nkxZIz5~#U_-Pb(0}iABtvPDxc9 zPPeJ5DzOo_daBAl2nnT$IbXA5uQT4Q4~A5PD#kAQRA?qhH8ClY)jp$kB#^yi6q@Eq z6bq7OKEC@AJEK?L+IW`bwSb^b^LA3;n8q<_2NymuZbNILFw{`)s}7p2lLh*yqek=a z)5pgNu#qMY^d)+9?d*|2@x5yinMGaff8BTZ2B{R7#jG@~=5HpOpq&ecnz?3~F&|BUB1V$F z{{vMleO1gSLB*aQqZUZ}lym1ro;0lQdIK$y|H)cbBXNDA38 zq8dtaFi~tu#^{Cn5Y%|Edz2<>U53}n@>HYJ9i)Hj@VWhPhkz4f)o)HfR^W;<$7~H~hP9+&7^zvbN!5Z=IN0LN zGgj+!9;!fM=Yub6@1%dU4UBRFP)vJ?{*ZXOtxKlJJUP9n#al*blo}tgM&S)b^y|*WWnAYJQJ23Vq74azVyDnPVi?ZM0*=UK|~bnxO5{`o@Ho zAe{Ej0};rwVD(Iv-DFd8jkuqpj&#wa@~%k*b^SrZjgzv0vXd>J+snO0d?`aeeu2(4 zL2Rlqo(-iye6;Gn?q7P`McTupXCt)AV$ghI#Z52?8>x~B;_89?o9MHuFatWl^Qa!< z(01~<`etXc`^;zNdNg~E(I>6UpQ23RUeja!`<=A-naVFL5~xK zr-C#lQdd1{hn4CF^n@)9X|5vJs5V5_S0dAGoW>;n!N0K|XKP-Al&NZ?t}PVKQ{J`a z<8>dJUL*xejSr+dOeKnMbXb7vhgDWKsUb$G_b2-X$G zg@)|AP$1cvHMGS!eZ`*ky#&X-*?G7NW@AU0i#FL{JMRsF?8|m`yY#fF?oDZi2-?St z@zwhbV60Uac3af)K{J3NK+hS0uMxwwFz`hT4=p;A{y12L7y}w~|H9i){3rD=MOf94 zc^6ZdIChK7D_$t{d~H5u4&e3Nq=zCTj`t2m5oSfzbK{?S6uM$793qz-wc#%vnSpqA z_Qqc>50DDhXeUtn@_xtH%cV?F7^;$HG7^9PxS~FTvFH4fFhnVXevz!??FBf9-zCr# zD-FL41bUNG{9sel0lV)FQRUD^{r%gOG5t==^M$%)S;B4jve5U`h3hFk=Wc&jg#kNv zZwvDiC>A8cF?%}jQKP4E$32fuvcF47^BSW+$2$#MJ)4R4u^Lsl$>u=Llii6UhHPev zZfXfq$Albj0SCf(5R$_jVZSX2^I>v?zV_HSPA}``}$o(EPJ4vPV=$0)t%uAWE!M2mP`oZ zaS&C!M)gTMxj2R+zUJG$iF)cOnZTfzPK*hGEPfoC-#tD3K&;5H(FWANuz#e^zO;M&N((8EY;i_>QZkRJDS-p%*ACAJ>;rC)LQ02aoxJc z2wXh@39j1io=^~#^H_B{*~4xaoWAW9s_w26Jpa5}Ml1Q;Q*(g|>yhZO9-8u_2P>@5 z9@;=wFh^o!6l)ldsKmRa^-%qN4)C0-GX*nBK4mDCcY{gG=`sPA~52wlrUaEyZY)Ce+EpKw~3o)pp(&{gb z*HVRXyLayAB&1f-a3SKvCX#x9^g3;lhlsDngz-;JaUf%vYx-Ggy`OulCMZHM#ct*P zaH@BG`S-z6MfepjF?w;H-0w*#G(H*v-E{h=IS=$23qZ{Z@gjWgH4iSxoVv=ne=@uP zI+c!1JU&cVW3wExIL%W`7zu2nkLerZO^J>!W3#?bX(*i{NZNbQ$g)Wg5u@$RVBzpu=Y+){ta=m=3|-`au4J+zNw`*X%=P#pt{pw6 ziIG7V>nWtdrbBM5a#DIf=S1{)zihWX+c48+WkxWldEQYJ)%D3?y)|G->pDCbA_;&Y ziKaV#v`xQGBm*$`v*_kdaNk$@S;TZjFsxD)mYT`tfTJT&3( za-hvNJX#&gxR<||seNi_63OA40cG{IN7Y};M$}q@8VAC7<|TnzN=0SFY{=z{Q3P)F z&JgKzi|_A}09PoQ63Be!NOl9MoT%Z5W`-0{&dykt{NU4f56M*pyPAMD=o)PvTdENYDcB1MtSnKDt;`-N@LeE5RgVP&0qh!D&L)#pr zj1w~mo80fZIy-kt_L7AqQ?BhHY+kcz-uI1KtuOFR0D0xsYO1NGTGQ_dJZG{o+g1W` zi7BFTPYvFKhsr+{qS7hE84nepeanJA&fN^M zJtZ5@`Hc8MRiHt@+!-CU zF165|L<6gc-$NNz20`%U5l5dMA)U7{lMx^#RG@>;l4zcY-tuzpStL=usi+hfa=4N_ zGa+B0&!~c5ibMwp#sSX6vA20mOc_w&a--fy-cfWPe*(iB9(Ns%pHw^U%`mu>hIlT8 z$%h>lA$G2KSe3Nw z@=)pGdt(aO5CiOuLB++=d|Nr@K_yz^9xfykkw2r#C&G-cEsbU9b$9NWE*F!*7dd31 zgnwD_R41T5OAhe zq=30~mahIr;EGPk#c*CbU#V>k)u+ye=d;NlO-A~3{axiI@pm`jBO$*=eX(Q!-eKU! z*)gQsQQd%@`A1O-lYnM7IrlBUGnrH!BAILAy9!b-whU~_d+Fr`L5n`E-8O$$GqFhk zJ4wt~N^YMO7 zd5N<4QAbQ}<)tDY~7y+d+Yz2o?7Jn1@uiyOM-U7Ni?KGPS|C6>qzxzJ||Hr|< zB}m76%vgurrqP8{Cj zUu62R!P(vx(w}NAP<@Av9s8c5O+2Z@|LDk>HHdD(=d}G9pPpG#C@QeN4m?Q-n z1s<$t&~3Z{?vMHUSgX7evxdLIUe-3+qRK5#CBI&lJGMVXh54^VIGx;-I4ml#| zD!^LHQbjslP$ICr!4DoGZG;&1c zEV+b-CW-bMW4LVl1P5~(K4~IjuCt9iZ{P@L>oA=-ZiLpD=3kZ$KeFt{Cji|;ZFlz` zTvoHOUHH!iCVx(qa>9&tpEx7zWUN?(MioW=NC~P;wy)CP+y?Y3_F_?!%2*+1;IR``y**rSta3bT{_FJR_(!+#GFF7muGP)(u4Y zY900s4KS^TR^AX-uKL{ARW6R@{8*Xk8^1g1_)at3U0x_G$T`sY?(udDm(PegLujD2 zk3FhZyfTIzRYH!^>2roLrNW$;QcZ(l%-}{KNsVw$0s8pSlRD~2c^2ZhT7*b-TYP1f zBeO5128Ht9mq&oy`LR7Z=U9=HV%fX@!`@qXMcu6ryn-Mlf=G8sNJ}?}(jXxrogxjw z&@Ca2bVx`eU4zunAqXQK0}MSh(m8Oy_?~mmdC&R%19#oC)-2Yn#TthF-FrX%e4Yv~ z!E(i>I^!PBX-8k!QGA1jbZ8y=91c1`g^1Y`*c>`f{6O5}gxz9_=l2Et-bSOkN8;q{ zc#Tl_X>9T6-`iZ-XO;^uL8|!KgiJq~Pc-&?SrqlTYPj_b$NO}}*;=V`q^?5Td3aKr zKW<74D1Rp(Oh?ZeSmr3hOC8$M#@5s+dTC38#{7cG-=mX^}|ww*q$a0;%%=6 z*$feoX#T3WZOw*>b}63zI&lqwX^W+%xKeM;>S&Yr=eQVhTm6zTo^j#K(bU+y>mc9! zO7XT!Bn@TE=f3=N@%3Ij&A{<|UnAdDrqj8;6|xWxtT5|;8r^?xycE%6-EXM!8D;hH zL+*y25Z8_ZgI9t`F5HbIn^!9-D%gq_o=fIHH!i_PLIof$I46Y2f_6%tC&}9su)luxJfIFB3+&#X z!tQUV8K_Z8SYfaNz21&UCiGBuT1PrEy|a^*mO?*zL&zs`zU8jT;ryIfHPz|Vh{_IL zQCc*lepYtB(q{@nAt`R}rNFf(-l{ZC-^T?!k2U8JH==-X;q@o9M}1!d5Wc?6)6Z~i zuM|eiB~bFo{BJBp@x1c7y~ZC9;UAZuT*s)w>J7(7f3~gvD`@=3dIXZ?$=~j2SbvkA z&%NBA=c$kQ(7(fTULKXPIF9Nm2IQi8mA_bu;`)fk@{f^>sN5zX9PB~1Tp8)keQc5z zb?xeGIab5lrh`q_5;NN6ZrzyzgBqZgj&k!q%_0-e55M}&ml;O-HzUMXnjo3(aFX!tl4etIPO6@UILIM(+^ax1 zc3iO|;d|seLqJKL=5Nbt&yJR;m^UNyIY#wL*Pi^dKTNSr(%%Oyt_3aj@0-5#S3jWL zjAw1K`r_&YmtXi{cXz2`M?eGDJSYF#!IRdbvGMKSKdhU<4Q?D1)4_1Wv^|$^Hh(`M z9xavom>e00)%c}#`whi3@wPy?!-k|2hb^bq>ULCncba#Z6^5%Z1Bi61sct1;N>e!V zI_l`mP;!fSq5vKVT(^U}CO6RbV9~XJeT;2SUHka_Uc6jbVR>%AWH~dZ&1N3ikl~`D zG+UBEAVEFl7I@*=A80|*o0gD>$^ET$xYN&fUgSvzu!PK}0M^%uF-MBH z8?SepY*eav_Xk?Ev&8)=fSxqfI){oQmdL?hBV#-Frk+1Da<#jUH{CvIR2~@Zev!rL z@1xr*Y?E14pKg>w2#h7KqDEMNy~dhs>L&_(6N-(9Oa>+=V(-P*{hi+cR7mM=p~`Pf z<_84hIk8_OXtv#_tWG0v@OuX1O0Qm`V5&%Vp~uE2hr6q!?=_tiM`~(tGd`rXY)0`P z2hHd;dm`&($OP8iVYd;-KGFxo9C~!D{RQ`ef}SZ}QW2xGI*3%b2(eZohcUFaAF2 zk^>p)`z9TuO)Op8LD_&RhvXOg24G*=sm2t^+nM^g3wHA<vkXXv~c|HS3qb)$QT{6%ZrGx4^!hJMR2cXa2qS>CxUuwKd;v1as(&uVajIMkPs@ z-B_=iD?`Vom%^-rPe}d|ODtf@l_X0ItPpbHeSeI}<-+lK`4tmH-vSV;6A4>v>`la4 zcn6%HSD0?CeK~zN4EVfM@3DRi{ySMnsso!Hgpv=ffU&MT(3x)&5I$*)QatQRhPsC* z2#Q?HL|x3tZfPhbb6i5=s(pZ3@lU1$N`zdB0$<)NbG)znx#Ez>59-4i6m)oh>1znd zHdvz-tn)HX5o=~IphuP8)fcG4fbOJMUpdZKv+1a}_&6g~we!4AIh_HU2Op#pSy?ni z(_}GE{*>KFafK4BeYpq=ciXx3C4?Jn)dxvY>G9W`7{t5OZ*6Xb)>KkQ1tUn5v1yYg zEKgg|!86v-E0rSZq^b9sDMAuP<4N{mIM45kygr4`P8xtlPJmL)&EK|g=*DH*IKkk) z_r4N*ctb?)-jD6ye@C|wLfSP*q{uJ*n;9n+D=60O=7*N&r#f+&?YSP(vOcaQc%D); z=eA4?o|#QU2{M3b2dpGXx2hO^8_>8bZJ89anRvqW7q}vEK~H`#kx*&?EMA_$wpqW9 z(2QAd;1GpCbNAe^1*mW<_jTOVQYPgPQu^ST39)qB`y! zsznwLl)JWBH!n|6wCveR^cPu08*00}kT744IYdc=ubrb0QeWr?CT)T9@4q_@EboDc zT4X8n6mD(2`I*RBQdGp7<<--Q0tF3)StC*@#Vyptx=e$y#6bmxtd+HYAPESwDO4ZL=dPjbE`+^T^BCMxBT2 z&)}nPz1`&NWxoMh34Cu1=x9&>Am0;tNMP@@%zN;Im`Uq(lV8`p(bEd_F=)k8O+HT-ApnO7uGZWXq zy{P<f;6{ zbN80~=I!Qt5NX>;+E4iw%NP!=p?B~fGSzga_N4vkUn6ZrLwV>L@qQGaa|a~y)m`7QuB0&>Qmc)unONYlhc}6DjNHoOwC#`g zHw>O~>?3sQ?`e!;x&f>#6wg=0^;_z{_l~j)UotH8$R&(H_(alVSv3JeAU?jxU2JLd zee;s!3~I=ozo4XjWBvX8@pW_uY*z8a_7yat;tVMJ)JWl5OY&O3rY2M9=Kp5cP-`?W zO@osEkbvo5>5;p4=xjg(wDUxwYu6VJ?k6-zrNH2>N^eQ?ZoXZnhqSm<;zRWV9)c^K zn2yUxWqVD9h9vgJn?na(kCZlf;ix9}_vE-w_EVIw_ugm4^WxEDEL`SIg%0fubctSQ z9r-EGh8yqsFH&vau9p)n