github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/slo.devdocs.json

1442 lines
No EOL
76 KiB
JSON
Raw Blame History

{
"id": "slo",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup",
"type": "Interface",
"tags": [],
"label": "SLOPublicPluginsSetup",
"description": [],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginSetup",
"text": "DataPublicPluginSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.licensing",
"type": "Object",
"tags": [],
"label": "licensing",
"description": [],
"signature": [
{
"pluginId": "licensing",
"scope": "public",
"docId": "kibLicensingPluginApi",
"section": "def-public.LicensingPluginSetup",
"text": "LicensingPluginSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.observability",
"type": "Object",
"tags": [],
"label": "observability",
"description": [],
"signature": [
"{ dashboard: { register: <T extends ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ObservabilityFetchDataPlugins",
"text": "ObservabilityFetchDataPlugins"
},
">({ appName, fetchData, hasData, }: { appName: T; } & ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.DataHandler",
"text": "DataHandler"
},
"<T>) => void; }; observabilityRuleTypeRegistry: { register: (type: ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ObservabilityRuleTypeModel",
"text": "ObservabilityRuleTypeModel"
},
"<any>) => void; getFormatter: (typeId: string) => ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ObservabilityRuleTypeFormatter",
"text": "ObservabilityRuleTypeFormatter"
},
" | undefined; list: () => string[]; }; useRulesLink: (options?: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.Options",
"text": "Options"
},
") => ",
"LinkProps",
"; rulesLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.RulesParams",
"text": "RulesParams"
},
">; ruleDetailsLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"RuleDetailsLocatorParams",
">; config: ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ConfigSchema",
"text": "ConfigSchema"
},
"; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.observabilityAIAssistant",
"type": "Object",
"tags": [],
"label": "observabilityAIAssistant",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "public",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-public.ObservabilityAIAssistantPublicSetup",
"text": "ObservabilityAIAssistantPublicSetup"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.observabilityShared",
"type": "Object",
"tags": [],
"label": "observabilityShared",
"description": [],
"signature": [
"{ registerProfilingComponent: <T>(key: string, component: React.FC<T>) => void; locators: ObservabilitySharedLocators; navigation: { registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.presentationUtil",
"type": "Object",
"tags": [],
"label": "presentationUtil",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationUtilPluginStart",
"text": "PresentationUtilPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.serverless",
"type": "Object",
"tags": [],
"label": "serverless",
"description": [],
"signature": [
{
"pluginId": "serverless",
"scope": "public",
"docId": "kibServerlessPluginApi",
"section": "def-public.ServerlessPluginSetup",
"text": "ServerlessPluginSetup"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.share",
"type": "Object",
"tags": [],
"label": "share",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePublicSetup",
"text": "SharePublicSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.triggersActionsUi",
"type": "Object",
"tags": [],
"label": "triggersActionsUi",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginSetup",
"text": "TriggersAndActionsUIPublicPluginSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerActionAsync: <Context extends object>(id: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>>) => void; readonly unregisterAction: (actionId: string) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly addTriggerActionAsync: (triggerId: string, actionId: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>>) => void; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionSetup",
"text": "UsageCollectionSetup"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsSetup.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.SecurityPluginSetup",
"text": "SecurityPluginSetup"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart",
"type": "Interface",
"tags": [],
"label": "SLOPublicPluginsStart",
"description": [],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.aiops",
"type": "Object",
"tags": [],
"label": "aiops",
"description": [],
"signature": [
{
"pluginId": "aiops",
"scope": "public",
"docId": "kibAiopsPluginApi",
"section": "def-public.AiopsPluginStart",
"text": "AiopsPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.cases",
"type": "Object",
"tags": [],
"label": "cases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesPublicStart",
"text": "CasesPublicStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.charts",
"type": "CompoundType",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
},
" & { activeCursor: ",
"ActiveCursor",
"; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.cloud",
"type": "Object",
"tags": [],
"label": "cloud",
"description": [],
"signature": [
{
"pluginId": "cloud",
"scope": "public",
"docId": "kibCloudPluginApi",
"section": "def-public.CloudStart",
"text": "CloudStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.dashboard",
"type": "Object",
"tags": [],
"label": "dashboard",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardStart",
"text": "DashboardStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.dataViewEditor",
"type": "Object",
"tags": [],
"label": "dataViewEditor",
"description": [],
"signature": [
{
"pluginId": "dataViewEditor",
"scope": "public",
"docId": "kibDataViewEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.dataViewFieldEditor",
"type": "Object",
"tags": [],
"label": "dataViewFieldEditor",
"description": [],
"signature": [
{
"pluginId": "dataViewFieldEditor",
"scope": "public",
"docId": "kibDataViewFieldEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.discover",
"type": "Object",
"tags": [],
"label": "discover",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverStart",
"text": "DiscoverStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.discoverShared",
"type": "Object",
"tags": [],
"label": "discoverShared",
"description": [],
"signature": [
{
"pluginId": "discoverShared",
"scope": "public",
"docId": "kibDiscoverSharedPluginApi",
"section": "def-public.DiscoverSharedPublicStart",
"text": "DiscoverSharedPublicStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.embeddableEnhanced",
"type": "Object",
"tags": [],
"label": "embeddableEnhanced",
"description": [],
"signature": [
{
"pluginId": "embeddableEnhanced",
"scope": "public",
"docId": "kibEmbeddableEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.fieldFormats",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry"
},
", \"init\" | \"register\"> & { deserialize: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FormatFactory",
"text": "FormatFactory"
},
"; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.lens",
"type": "Object",
"tags": [],
"label": "lens",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensPublicStart",
"text": "LensPublicStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.licensing",
"type": "Object",
"tags": [],
"label": "licensing",
"description": [],
"signature": [
{
"pluginId": "licensing",
"scope": "public",
"docId": "kibLicensingPluginApi",
"section": "def-public.LicensingPluginStart",
"text": "LicensingPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.observability",
"type": "Object",
"tags": [],
"label": "observability",
"description": [],
"signature": [
"{ config: ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ConfigSchema",
"text": "ConfigSchema"
},
"; observabilityRuleTypeRegistry: { register: (type: ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ObservabilityRuleTypeModel",
"text": "ObservabilityRuleTypeModel"
},
"<any>) => void; getFormatter: (typeId: string) => ",
{
"pluginId": "observability",
"scope": "public",
"docId": "kibObservabilityPluginApi",
"section": "def-public.ObservabilityRuleTypeFormatter",
"text": "ObservabilityRuleTypeFormatter"
},
" | undefined; list: () => string[]; }; useRulesLink: (options?: ",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.Options",
"text": "Options"
},
") => ",
"LinkProps",
"; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.observabilityAIAssistant",
"type": "Object",
"tags": [],
"label": "observabilityAIAssistant",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "public",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-public.ObservabilityAIAssistantPublicStart",
"text": "ObservabilityAIAssistantPublicStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.observabilityShared",
"type": "Object",
"tags": [],
"label": "observabilityShared",
"description": [],
"signature": [
"{ locators: ObservabilitySharedLocators; navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => React.JSX.Element; registerSections: (sections$: ",
"Observable",
"<",
{
"pluginId": "observabilityShared",
"scope": "public",
"docId": "kibObservabilitySharedPluginApi",
"section": "def-public.NavigationSection",
"text": "NavigationSection"
},
"[]>) => void; }; updateGlobalNavigation: ({ capabilities, deepLinks, updater$, }: { capabilities: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; discover?: Readonly<{}> | undefined; dashboard?: Readonly<{}> | undefined; maps?: Readonly<{}> | undefined; visualize?: Readonly<{}> | undefined; }>; deepLinks: ",
"AppDeepLink",
"<string>[]; updater$: ",
"Subject",
"<",
"AppUpdater",
">; }) => void; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.presentationUtil",
"type": "Object",
"tags": [],
"label": "presentationUtil",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationUtilPluginStart",
"text": "PresentationUtilPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.serverless",
"type": "Object",
"tags": [],
"label": "serverless",
"description": [],
"signature": [
{
"pluginId": "serverless",
"scope": "public",
"docId": "kibServerlessPluginApi",
"section": "def-public.ServerlessPluginStart",
"text": "ServerlessPluginStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"signature": [
"{ toggleShareContextMenu: (options: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions",
"text": "ShowShareMenuOptions"
},
") => void; } & { url: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.BrowserUrlService",
"text": "BrowserUrlService"
},
"; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">): void; availableIntegrations: (objectType: string, groupId?: string | undefined) => ",
"ShareActionIntents",
"[]; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.spaces",
"type": "Object",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
{
"pluginId": "spaces",
"scope": "public",
"docId": "kibSpacesPluginApi",
"section": "def-public.SpacesApi",
"text": "SpacesApi"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.triggersActionsUi",
"type": "Object",
"tags": [],
"label": "triggersActionsUi",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
"text": "TriggersAndActionsUIPublicPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly hasTrigger: (triggerId: string) => boolean; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerActionAsync: <Context extends object>(id: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>>) => void; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly addTriggerActionAsync: (triggerId: string, actionId: string, getDefinition: () => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>>) => void; readonly getAction: (id: string) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>>; readonly getTriggerActions: (triggerId: string) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly getFrequentlyChangingActionsForTrigger: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.FrequentCompatibilityChangeAction",
"text": "FrequentCompatibilityChangeAction"
},
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
"; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionStart",
"text": "UsageCollectionStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.SecurityPluginStart",
"text": "SecurityPluginStart"
},
" | undefined"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.fieldsMetadata",
"type": "Object",
"tags": [],
"label": "fieldsMetadata",
"description": [],
"signature": [
{
"pluginId": "fieldsMetadata",
"scope": "public",
"docId": "kibFieldsMetadataPluginApi",
"section": "def-public.FieldsMetadataPublicStart",
"text": "FieldsMetadataPublicStart"
}
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "slo",
"id": "def-public.SLOPublicPluginsStart.apmSourcesAccess",
"type": "Object",
"tags": [],
"label": "apmSourcesAccess",
"description": [],
"signature": [
"{ getApmIndices: (options?: Omit<",
{
"pluginId": "apmSourcesAccess",
"scope": "public",
"docId": "kibApmSourcesAccessPluginApi",
"section": "def-public.SourcesApiOptions",
"text": "SourcesApiOptions"
},
", \"body\"> | undefined) => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>; getApmIndexSettings: (options?: Omit<",
{
"pluginId": "apmSourcesAccess",
"scope": "public",
"docId": "kibApmSourcesAccessPluginApi",
"section": "def-public.SourcesApiOptions",
"text": "SourcesApiOptions"
},
", \"body\"> | undefined) => Promise<",
"ApmIndexSettingsResponse",
">; saveApmIndices: (options: ",
{
"pluginId": "apmSourcesAccess",
"scope": "public",
"docId": "kibApmSourcesAccessPluginApi",
"section": "def-public.SourcesApiOptions",
"text": "SourcesApiOptions"
},
" & { body: Partial<Record<\"error\" | \"transaction\" | \"span\" | \"metric\" | \"onboarding\" | \"sourcemap\", string>>; }) => Promise<",
"SavedObject",
"<{}>>; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "slo",
"id": "def-public.SLOPublicStart",
"type": "Type",
"tags": [],
"label": "SLOPublicStart",
"description": [],
"signature": [
"{ getCreateSLOFlyout: React.FunctionComponent<{ onClose: () => void; initialValues?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.RecursivePartial",
"text": "RecursivePartial"
},
"<{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; }; total: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"cardinality\" | \"last_value\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; syncField?: string | null | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | string[] | undefined; revision?: number | undefined; }> | undefined; }>; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "slo",
"id": "def-public.SLOPublicSetup",
"type": "Type",
"tags": [],
"label": "SLOPublicSetup",
"description": [],
"signature": [
"{ sloDetailsLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"SloDetailsLocatorParams",
">; sloEditLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"RecursivePartial",
"<{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; }; total: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"cardinality\" | \"last_value\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: ({ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; } & { $state?: any; })[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; syncField?: string | null | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | string[] | undefined; revision?: number | undefined; }>>; sloListLocator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"SloListLocatorParams",
">; }"
],
"path": "x-pack/solutions/observability/plugins/slo/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "slo",
"id": "def-server.SloClient",
"type": "Interface",
"tags": [],
"label": "SloClient",
"description": [],
"path": "x-pack/solutions/observability/plugins/slo/server/client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "slo",
"id": "def-server.SloClient.getSummaryIndices",
"type": "Function",
"tags": [],
"label": "getSummaryIndices",
"description": [],
"signature": [
"() => Promise<string[]>"
],
"path": "x-pack/solutions/observability/plugins/slo/server/client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "slo",
"id": "def-server.SLOServerSetup",
"type": "Interface",
"tags": [],
"label": "SLOServerSetup",
"description": [],
"path": "x-pack/solutions/observability/plugins/slo/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "slo",
"id": "def-server.SLOServerStart",
"type": "Interface",
"tags": [],
"label": "SLOServerStart",
"description": [],
"path": "x-pack/solutions/observability/plugins/slo/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "slo",
"id": "def-server.SLOServerStart.getSloClientWithRequest",
"type": "Function",
"tags": [],
"label": "getSloClientWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "slo",
"scope": "server",
"docId": "kibSloPluginApi",
"section": "def-server.SloClient",
"text": "SloClient"
}
],
"path": "x-pack/solutions/observability/plugins/slo/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "slo",
"id": "def-server.SLOServerStart.getSloClientWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/solutions/observability/plugins/slo/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "slo",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"SLOs\""
],
"path": "x-pack/solutions/observability/plugins/slo/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "slo",
"id": "def-common.sloAppId",
"type": "string",
"tags": [],
"label": "sloAppId",
"description": [],
"signature": [
"\"slo\""
],
"path": "x-pack/solutions/observability/plugins/slo/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "slo",
"id": "def-common.sloPaths",
"type": "Object",
"tags": [],
"label": "sloPaths",
"description": [],
"signature": [
"{ slos: string; slosSettings: string; slosWelcome: string; slosManagement: string; sloCreate: string; sloCreateWithEncodedForm: (encodedParams: string) => string; sloEdit: (sloId: string) => string; sloEditWithEncodedForm: (sloId: string, encodedParams: string) => string; sloDetails: (sloId: string, instanceId: string, remoteName?: string | undefined, tabId?: string | undefined) => string; }"
],
"path": "x-pack/solutions/observability/plugins/slo/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink